Back Forward Help: Performance tool — Using the summary display

Show all 

C-694 Use the Performance tool to understand the system resources consumed by processing of a single requestor session, or the SQL statements sent by the requestor session to the PegaRULES database.

Process Commander always accumulates cumulative resource statistics for the Performance tool. Use the tool to display these statistics, and to identify incremental resources (in the delta rows) consumed by your processing. Because this feature displays existing data its use does not degrade processing.

Basics

Using this data, you can assess possible sources of improved performance (faster response time or higher throughput) through software changes, hardware changes, or rule changes.

As Process Commander operates, it collects statistics about the demands made on processing resources, and the server system's response. The Performance tool summarizes and formats these statistics and presents them as HTML pages.

Performance data shows the processing demand statistics of your work since you connected, and may help you assess the performance impact between different approaches or configuration choices.

The DB Trace facility records SQL interactions between your Process Commander session and the PegaRULES database.

Performance statistics can help you distinguish between performance issues that arise in the Process Commander server, the PegaRULES database, or external systems called by the workflow. In all cases, the statistics can help you determine how to improve performance.

Using the links

Use these links at the top of the summary display:

Link

Effect

Add Reading A new row of summary performance data appears. Statistics include input/output, elapsed time in seconds for certain processing, cache performance, locking, and server CPU demand, for the most recent interaction. Optionally, first click elsewhere in the portal window and perform one or several interactions that cause the performance you want to measure. The system retains extensive data for each interaction.
Add Reading with Clipboard Size A new row of summary performance data appears, including the size of the clipboard in bytes. Similar to Add Reading, but may add potentially costly processing. (Using the System Management Application (SMA), you can learn the size of each page. Start the SMA using Pega Button > System > Tools > System Management Application, select a node, then click the Requestor Management menu item.) 5.5 GRP-372
Reset Data Initializes all counts and totals to zero.
Save data Lets you save more than 100 statistics and values from each row into a Comma-Separated-Values file (CSV file type) for analysis with Microsoft Excel or other facilities. Column headings correspond to properties in the Code-Pega-PAL class, as presented on the Full Details display. (The value NaN indicates that a statistic was not available.)
Start DB Trace Starts the DB Trace tool to trace PegaRULES database operations. See DB Trace Results.
DB Trace Options See Setting DB Trace Options.
Start Profiler Starts the Profiler too to provide detailed CPU statistics for activity steps. See About the Profiler. The link changes to Stop Profiler.
Show Graph Presents a bar chart highlighting major factors affecting performance. C-2656 5.2 See Interpreting the Performance Summary chart.
My Alerts Provides additional detail on alerts from your own requestor session (or other filter criteria you provide). See Working with the My Alerts display. CODE-271 PROJ-505
Help Displays this help topic.
PDN Queries the PDNPega Developer Network for the most recent articles regarding this tool. WWW access is required.

For each summary row, many more statistics are available on the full detail page. To see full details, click the Full or Init link on a row.

Understanding the basic statistics

The basic statistics display has three or four rows. On the initial display, statistics in the row labeled Full match those in the bottom row.

As you interact with Process Commander, the statistics change to reflect the results of each interaction.

Label

Description

full

Statistics in the top row reflect totals since your session started, or since the most recent Reset Data operation.

(none)

The second row provides labels for the columns.

delta

Delta rows appear as you interact with Process Commander. Each row shows values from a single interaction.

init

The bottom row shows the totals when this Performance display first appeared.

Columns of the display identify these counts and timings. The table below describes returned data. All CPU time is in milliseconds. The properties are stored in the PALPhase clipboard page, and are in the Code-Pega-PAL class.

The number of decimal places in timing results depends on the hardware and software in use. In general, the decimal values shown are significant. Measurement values are since log-in, or since the last Reset, or incremental between rows, depending on the row label.

Label

Description

Int # Sequence number of the most recent completed interaction.
Int Count Total number of interactions.
Total Elapsed Total elapsed time for this interaction.
RA Elapsed Rules assembly elapsed time.
Rule I/O Elapsed Elapsed time spent finding rules.
Connect Elapsed Time spent waiting for the external system during connectors.
Other I/O Elapsed Elapsed time accessing non-rule-resolved instances from the PegaRULES database plus elapsed time retrieving non-rule database lists. B-15223B-20478
Total CPU Total CPU time used.
RA CPU CPU time spent assembling Java classes.
Rule CPU CPU time spent executing rules.
Other CPU CPU time excluding rules assembly CPU and Rule CPU.
RA Count Number of Java classes assembled.
Rule Count Number of times rules are found.
Activity Count Number of activities started by this thread, including activities where an exception occurred during execution.
Connect Count Number of connector attempts made to external systems.
Other I/O Count
pxOtherIOCount
Number of times Process Commander attempts to create lists from the database. B-18649
Alert Count
pxAlertCount
Number of alerts created by your requestor session. Code-240 Proj-505
Total Bytes Total bytes of input and output.

Accessing the full details display

Click the INIT, FULL, or DELTA links to access the Full Details display for that row. This display provides additional statistics from the same snapshot. B-24716 B-24755

For a description of the contents of that window, see Performance tool — Full Details Display.

Monitoring SQL operations with DB Trace

C-1261 You can monitor the interactions between Process Commander's server engine and the PegaRULES database or other relational databases. Familiarity with SQL is required to interpret the output.

To use this facility:

  1. Click DB Trace Options to set up which database events are monitored. See Setting DB Trace options.
  2. Click the Start DB Trace link to turn on the facility and record SQL statements that Process Commander sends to the database software.
  3. Click Stop DB Trace to end data collection and access the trace results as a text file or with Microsoft Excel. See Interpreting DB Trace Results. B-3871VAGUE

Unlike the resource statistics feature, the DB Trace feature is normally off. Use the DB Trace feature only for a brief interval. When enabled, DB Trace processing can produce voluminous output and may adversely affect session performance.

NoteThe DB Trace facility is available only on non-production systems, for users who have the PegaRULES:SysAdm4 access role. This access role provides access to the standard privilege named Code-Pega-.PerformanceTools.

Note An alternative approach that provides comprehensive tracing of SQL statements sent to the PegaRULES database is the dumpStats parameter in the prconfig.xml file. SR-1226

Technical note

When two instances of Process Commander are installed on a single Windows server, some Performance tool statistics may not be available on the installation that is started second. SR-547 REALLY?

Related topics About the System Management application
Performance tool — Full details display

UpTools, accelerators, and wizards