This content has been archived and is no longer being maintained.

Table of Contents

Article

Introduction to the Tracer Tool

Summary

What is the Tracer tool for? How do I get started using it to see details about my activities and flows?

Suggested Approach

Use the Tracer tool to test and debug activities, flows, and other rules.

Within the Tracer tool, you can see the processing performed during run-time in summary or in detail. You can pause and resume processing, view or set the value of watch variables, and drill down to step-by-step details. You can view trace events for any requestor connected to your server node, not just your own session (if you know the connection ID of the session)..

Starting the Tracer tool

To start the Tracer tool, click the Tracer icon ( Tracer tool icon ) on the Quick Access bar of the Designer Studio to trace your current session and Thread.

Initial Tracer tool display:

Tracer tool initial display

When you first open the tool, the rows of the Tracer results display are empty. When you take a subsequent action in the system, the Tracer tool adds rows according to the trace criteria specified in the Trace Options.

Tracer Results display

The Tracer results display lists the events that you select in the Trace Options window. After opening the Tracer tool, click the Options button to set or adjust Tracer options:

Tracer Options button

By using various Trace options, you can set very fine-grained control over what you wish recorded in the execution trace. You specify the applicable events, break conditions, and targeted RuleSets.

Drilling down on event details

You can interact with the Tracer tool's results display to drill down for more information on specific events. By clicking on the values in the display columns, you can learn more about the event associated with that row, including seeing a Java stack trace if an exception occurred.

For example, in the illustration below, clicking the row identifier 17 in the Tracer results display opens a window that shows many facts about that event, and clicking the name of the primary page (ruletoVisualize) opens a window that shows information about that page.

Drill down on event

Troubleshooting

Sometimes, you may not see rows that you expect to see in the Trader results display; for example, steps for certain activities. A likely cause of not seeing any steps in the Tracer results is related to the Trace options being applied -- options set in either the Events to Trace or the RuleSets to Trace sections of the Trace Options window.

For example, the Tracer enforces RuleSet access controls.

Tracer output includes information only for rules in RuleSets that are checked in the the RuleSets to Trace section. So if the RuleSet that contains the activity is unselected in the RuleSets to Trace list, that activity's steps do not appear in the results

(Even when you trace a requestor session other than your own, the list of RuleSets you can trace is restricted to those available to your session. You can't use the Tracer to see execution of rules in RuleSets not available to you.)

If you do not see any activity steps in your Tracer results:

In the Events to Trace section, verify that the Start and End check boxes are selected for Activities and Activity Steps.

Trace Options - Activity settings

If you see some activity steps in the Tracer results, but not ones from certain activities:

In the Trace Options window, scroll down to the RuleSets to Trace section and verify that the RuleSets for those activities are selected.

For example, in the following picture, activities in the Pega-ProcessCommander RuleSet are not traced because that RuleSet is unchecked.

Trace Options - RuleSet settings

Tags:

Published June 16, 2010 — Updated November 15, 2015


81% found this useful

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.