The Pega-TracerViewer tool presents and summarizes Tracer output data, that is saved in an .xml file, in an interactive table or tree format. By using TracerViewer, you can analyze the Tracer data offline to understand what happens on your system, determine where performance bottlenecks occur, and diagnose additional issues.
README.mdfile might include information about additional prerequisites, for example a Java version that the latest Pega-TracerViewer requires. For more information, see Pega-TracerViewer.
After you run 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
By using the TracerViewer, you can perform 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 the slowest call.
- Search the Tracer tool output data.
- View Performance tool statistics for each interaction.
- View alerts and SQL statements in the context of where and when they occur.
- Group traced events by a key, such as a unique SQL statement, stream, activity, or method.
Starting with the 3.3 version, the TracerViewer supports standard Pega Platform applications that rely on Cosmos React. The output depends on the type of application that you trace. For Cosmos React, the output additionally includes DX API interaction IDs and DX API paths.
Debugging applications by using Pega-TracerViewer
Fix issues, prevent bottlenecks, and analyze events in your application by using the
Pega-TracerViewer tool. You can generate Tracer output in an
format so that you can continue debugging offline or share the results with other
- Download the latest version of the viewer from https://github.com/pegasystems/pega-tracerviewer/releases.
- Extract the files into a directory on your local operating system.Ensure that you maintain the viewer's directory structure.
- Open the
README.dmfile for instructions on how to launch the Pega-TracerViewer.
- Start the Tracer tool and configure the tool to capture the information about
the areas that you want to investigate, for example, the event types to
trace.For more information, see Configuring Tracer settings, Setting breakpoints in the Tracer tool, and Setting watch variables in the Tracer tool.
Note: If you plan to analyze the results in the tree view, in the Trace Options window, for events such as activities that have Begin and End options, either select or clear both check boxes to ensure that the viewer nests the events correctly in the tree view.
- 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 4.
- In the Tracer window, click Save to download the .xml file to your downloads directory.
- In the header of the TracerViewer, click File.
- In the file directory window, navigate to the .xml file with the Tracer output, and then open the file.
Obtaining and starting Pega-TracerViewer
Viewing Tracer output data in the TracerViewer