Tracer
|
Click the Options button () to set or adjust Tracer output options.
Click OK when your entries are complete.
To cause Tracer output to include certain events, check one or more Events to Trace boxes. These options are most relevant to debugging activities (rather than flows or declarative rules).
Select the boxes that identify the events of interest.
Events to Trace |
Description |
Exception | Select to cause the Tracer to display a line for every Java exception. In most cases, processing continues after the exception. |
Access Deny rules | Select to display a line at the start of each execution of an Access Deny rule. |
Activities Start | Select to display a line at the start of each activity execution. |
Activities End | Select to display a line at the completion of each activity execution. |
Activity Steps Start | Select to display a line at the start of every activity step and step iteration. |
Activity Steps End | Select to display a line at the completion of every activity step. |
When rules Start B-17691 | Select to display a line at the start of every when condition evaluation, including preconditions and transitions. ERNSG 8/4/04 C-428 |
When rules End |
Select to display a line at the completion of every when condition evaluation, including preconditions and transitions. If selected, Tracer output shows the results of all when rule executions from all RuleSets, regardless of your selected RuleSets. |
Models Start | Select to display a line at the beginning of every model execution. |
Models End | Select to display a line at the end of every model execution. |
To cause the Tracer to stop for specific events, check the Break Conditions check boxes. You can use the Tracer tool's Break button () to create other break conditions.
Use the Continue button () to continue, step-by-step, through an activity execution after any of the conditions in the following table causes processing to pause:
Break Conditions |
Description |
Exception |
Select to stop the Tracer upon the first Java exception. |
Fail Status |
Select to pause processing automatically when a step ends
with a |
Warn Status |
Select to pause processing if a step ends with a
|
Select Expand Java Pages if the processing
involves properties of mode Java Pages
. This option can
significantly slow processing. VAGUE
Select Abbreviate events to limit the clipboard details sent to the Tracer tool. VAGUE
Select the event types to trace
03-02 C-314 Complete the middle portion of this form to trace the progress of flows, declarative rules, or decision trees rules.
C-446 C-463For declarative rules, rows of the Tracer output show the operation of the dependency network — the forward and backward chaining computations that occur automatically.
Label |
Description |
Event | Optional. Enter an additional event type as instructed by Pegasystems Global Customer Services. Then click Add to enable tracing for this type. VAGUE |
Log Messages | Record each execution of the Log-Message method that has the Send Message to Tracer parameter selected. |
Flow | Trace a flow execution. Rows of the Tracer output identify each flow start and end, each task (shape) start and end, and the connectors (arrows on the Visio diagram). |
Constraints | Trace Constraints rules. |
Declare Expression | Trace Declare Expression rules. |
Declare Index | Trace Declare Index rules. |
Declare OnChange | Trace Declare OnChange rules. |
Declare Trigger | Trace Declare Trigger rules |
Decision Tree | Trace decision tree rules (start only) |
Decision Table | Trace decision table rules (start only) |
Decision Map | Trace map value rules (start only). LABEL BUG |
Collection | Trace collection rules. C-2547 |
Locking | Trace locking operations. Tracer output shows each lock acquired and each lock released. 5/2/05 |
Services | Trace service rules and service activities. See Tracer — Tracing services. |
Stream Rules | Trace stream rule execution. BURND 5/23/06 |
Parse Rules | Trace Parse XML, Parse Structure, and Parse Delimited rules. Other parse rule types are not traced. BURND 5/23/06 |
Auto Populated Properties | Trace the execution of auto-populated properties. GRP-498 |
CaseType | Trace case type rule calculations. (you must add it by entering CaseType in the Add Event field). V6.1 marik |
As an advanced debugging technique, you can add custom events to Tracer output as follows: 5/2/05 and 1/26/06 MARIK
sendDebugMessagetoTracer(strMessage,
strRuleSet)
at appropriate places. This function is
in the PegaRULES Utilities
library. Because this
function returns void
, it can't be used in most
methods. To include the function in a Java step, enter the call in
the form:
pega_rules_utilities.sendDebugMessagetoTracer(message, RuleSet)
Debug
in the
Event Type field. Click Add .By default, the Tracer does not report changes to reference properties. To enable tracing of such changes:
Reference Properties
in the Event
Type field. Click Add .Select the RuleSets to be traced
This panel lists all RuleSets you can access, in the order they appear in your RuleSet list. B-18715SR-2633
To trace the execution of rules in a specific RuleSet, check the corresponding box. The list shows all the RuleSets in your RuleSet list, based on your access group and other sources.
The Tracer always enforces RuleSet access controls. Whether tracing your own session or another user's session, Tracer output never includes information about rules executed that are in a RuleSet other than those checked. The Tracer display does not identify gaps caused by this restriction.
The four or five RuleSets listed last are base Process Commander RuleSets. You can select them for tracing, but this may cause the Tracer to produce large quantities of output. C-428 You can trace flow rules (of flows in your application RuleSets) without selecting the Pega-ProCom RuleSet or other base RuleSets.
Your selections for RuleSets you select do not affect Tracer output for when rules. If you selected the When rules End option (in the Events to Trace group), Tracer shows the outcome of every when rule you execute, in any RuleSet. 2/4/08
Set the number of lines to display
By default, the Tracer displays the 500 most recent trace lines. You can set a higher value; this requires additional workstation memory.
Label |
Description |
User Interface | |
Max Trace Events to Display |
Enter the number of lines to display. When Tracer output reaches this limit, the oldest lines are dropped to allow newer lines to appear. Proj-504 Code-133 ALIBJ 4/6/07 Changes to this limit take effect only the next time you start the Tracer tool. This feature is unrelated to and independent of the file event limit, which applies to unprocessed events — events not yet displayed. |
Avoiding event queue overflows
As initially installed, each Tracer session uses a file buffer that holds up to 500 events not yet processed for display. Some complex tracing situations reach this limit; additional events are discarded. The following message appears: PRKB-17626
Event queue is overflowing on server, events will be discarded.
To avoid this limitation, select fewer RuleSets or event types and then repeat the operation.
If this occurs often, you can increase the limit of the file buffer, which can contain many more events. See Tracer — Adjusting the file buffer size. If the problem persists after you have set a large buffer size, your application may contain an infinite loop.
Various conditions can cause the event queue to fill up. For example, if the Tracer and the traced requestor session are running on one client workstation, then both sessions share the normal limit of two HTTP operations to the server. If the traced operations involve many HTTP operations, then the Tracer contends with other browser operations for access to the server. This contention can cause the Tracer to drain the event queue more slowly, causing an event queue overflow.