The E2E Trace Wizard is designed to streamline the process of BI Platform E2E Tracing. This feature automates the steps outlined in KB Article 1861180.
The E2E Trace Wizard automates the following actions:
- Creates a backup of the original BO_trace.ini and deploys a new custom BO_trace.ini on each BI node in the specified landscape
- Collects GLF trace files from remote BI and Web Application hosts
- Collection of traces can occur via the SAP Host Agent or Shared Network Folders (UNC Path)
- Records a video capture of the E2E trace session
- Integrates the SAP Client Plug-in and launches it directly from the BIPST client
- Creates a zip file containing the BusinessTransaction.xml, GLF tracelogs, and video recording
- Once the trace session is completed, the original BO_trace.ini is restored
Step 1: Select Landscape
To begin an E2E Trace, first select the desired landscape from the Select a Landscape drop-down box then click Next to continue to the next step. If you have not yet created a landscape definition you will recieve a message stating No Landscapes found. To create a landscape definition, click on the Landscape Configuration button on the left navigation bar to define your landscape, then return to the E2E Trace Wizard to continue the E2E Trace.
Step 2: Confirm Settings
On this step, you will specify the settings that will be used during this trace session.
Refer to the table below for a description on each setting option.
|Landscape||Specifies the target BI landscape where the E2E Tracing will be executed|
|E2E Work Directory||The directory where the collected traces will be written. By default, this directory exists in your BIPST user profile directory. Click the '...' button to customize the location of your E2E working directory.|
|BI Log Collection||This option allows you to choose whether the BI traces will be collected using the SAP Host Agent or collected from a specified shared network folder.|
|WebApp Log Collection||This option allows you to choose whether the BOE Web Application traces will be collected using the SAP Host Agent or collected from a specified shared network folder.|
|Override BO_Trace.ini||If checked, the E2E Trace Wizard will first backup the current BO_Trace.ini, then it will create a new BO_trace.ini that is optimized for E2E Tracing. Once the E2E Trace session has completed, it will revert the BO_trace.ini back to the original setting.|
You can customize the BO_trace.ini settings that are used by going to Preferences > E2E Trace Settings or by clicking the Preferences button.
|Record E2E Session||If checked, the E2E Trace Wizard will record a video capture of the workflow. The *.cap file will be saved with the trace files and can be viewed using the 'Offline Video Player'.|
Use Integrated SAP Client Plug-in
The option Use Integrated SAP Client Plug-in tells the E2E Trace Wizard whether or not to use the SAP Client Plug-in that is included with the BIPST client. Since it is sometimes required to run the SAP Client Plug-in with elevated priveledges, it is recommended to check the option to 'Run As Administrator'
Enter the Domain, User Name, and Password of your account with local administrator access. If you are logged on locally (not a domain account), then use the local hostname in the domain field. The E2E Trace Wizard will launch the SAP Client Plug-in in the same manner as if you right clicked on the plugin and chose "Run as Adminstrator", however this is done programmtically.
If you chose to not use the Integrated SAP Client Plug-in then you will need to manually launch the SAP Client Plug-in on the next step.
Click the Begin Trace button to start the E2E Trace Session.
Step 3: Confirm Settings
On this step, you will launch Internet Explorer using the SAP Client Plug-in, then execute the problematic workflow. For more information on this step, refer to the "GENERATE THE TRACE" section of KB Article 1861180. If the SAP Client Plug-in did not launch automatically (or you chose the option to not use Integrated SAP Client Plug-in), then browse to sapclientplugin.exe and right click and "Run As Administrator".
- In the SAP Client Plug-in, make sure Application is set to Microsoft Internet Explorer then click the Launch button
- Under the Business Transaction Name field, enter a descriptive name that describes the workflow that you are capturing and set the Next Step TraceLevel to High.
Before you start your end to end trace, you should first queue up the browser to the beginning of the problematic workflow that you wish to trace.
It is best practice to only trace the transactions where the problem is occurring. Try to avoid additional browsing and clicking as this will generate extraneous logs and make analysis more difficult
- When you are ready to begin your workflow, click the Start Transaction button then execute only the workflow you are trying to trace. Observe that the number of sent bytes/received bytes will increase if the trace is working
- As soon as you have completed your workflow press the Stop Transaction button. You can ignore the message "Settings are not valid" as it relates to the SMD Agent settings for Solution Manager
- Click the "X" in the upper right corner of the SAP Client Plug-in to close the plug-in and Internet Explorer
- Click Next to continue to the next step
Step 4: Collect Trace Files
On Step 4, the E2E Trace Wizard automatically loads the most recent BusinessTransaction.xml and displays the specified Transaction Name, the target landscape where the E2E Trace was executed, and the Transaction ID.
If the Transaction Name displays the transaction that you just executed, then click Next to begin trace collection. The E2E Trace Wizard will begin collecting the traces from each BI node and Web Application Server node and copy them to E2E Work Directory location. The folder storing the files will be named after the Transaction ID. If the transaction is not automatically loaded or if you chose not to use the Integrated SAP Client Plug-in then click the '...' button and browse to the location of the BusinessTransaction.xml for this transaction.
Click Next to start the log collection
Step 5: Summary
In this step, you are provided a report that displays the results of the E2E Trace session. Click on the link for Directory to go to the directory where the collected logs will be stored.
Scroll down to see if any log collections failed from the various nodes in the landscape.
- No labels