Summarizing Tracer tool output by using Pega-TracerViewer
The Pega-TracerViewer tool presents and summarizes Tracer output data, saved in .xml format, in an interactive table or tree format. By using TracerViewer, you can analyze Tracer data offline to understand what is happening on your system, determine where performance bottlenecks are occurring, and diagnose issues.
After running the Tracer tool on Pega Platform™, save the output as an .xml file to your local system, and then open it in the viewer.
Key features of Pega-TracerViewer
The viewer works with Tracer .xml output from PRPC 6.x and later versions. Some viewer features are not available for Tracer output files that were created on a PRPC 6.1 system. For example, features that are related to viewing and sorting database-related trace data are not available for Tracer output from a PRPC 6.1 system.
By using TracerViewer, you can do the following actions:
- View the Tracer data offline after the test is complete.
- Organize the data in a table or in tree views.
- Sort the data, for example, by slowest call.
- Search the Tracer tool output data.
- View Performance tool statistics for each interaction (for 6.2 and later).
- View alerts and SQL statements in the context of where and when they occurred (for 6.2 and later).
- Group traced events by a key, such as a unique SQL statement (for 6.2 and later), stream, activity, or method.
Obtaining and starting Pega-TracerViewer
The viewer runs as a Windows executable file from a directory on your local Windows system.
- Download the viewer from https://github.com/pegasystems/pega-tracerviewer/releases.
- Extract the files into a directory on your local Windows system, maintaining the directory structure.
- Start the viewer from the Windows command line by navigating to the directory where you extracted the files and entering the pega-tracerviewer-3.1.cmd command.
Using the viewer with Tracer output data
To use the viewer with Tracer output data:
- Start the Tracer tool and configure it to capture the information about the areas that you want to investigate, such as the event types to trace.
In the Trace Options window, for events such as activities that have Begin and End options, make sure that either both check boxes are selected or both are cleared to ensure that the viewer displays the events correctly nested in the tree view.
For more information about the Tracer tool, see Application debugging using the Tracer tool.
- From Pega Platform, run the process that you want to investigate. For example, if you want to investigate the performance of a specific business process, run that process. As you perform actions on the system, the Tracer tool captures data according to the criteria that you set in step 1.
- Click Save to download the .xml file to your downloads directory.
- In the viewer, click File > Load Pega Tracer File.
- Browse to the saved Tracer .xml file, select it, and click Open.
The first time that you open a Tracer .xml file, the viewer takes a longer time to open than when it subsequently accesses the same file. After the first time that the viewer opens a file, it distills the file's data into a smaller file with a
.pk extension. If you obtain a new version of the TracerViewer tool and want to view Tracer output files that you previously viewed with the tool, delete the generated
.pk files before opening those files.
The following image shows sample Tracer tool output in Pega-TracerViewer:
Tracer tool output in Pega-TracerViewer