Back Forward Understanding alerts

Concepts and terms

 zzz Show all 

The Alert log, a series of text files, supplements the Pega logs (console logs). Typically, an Alert log file is named PegaRULES-Alert-YYYY-MMM-DD.log, where the date portion of the name indicates the date when the application server was started on the node. Security alerts are recorded in a similar file named PegaRULES-AlertSecurity-YYYY-MM-DD.log.

To view only those alerts from your own requestor session, select Tools > My Alerts. See Working with the My Alerts window.

 zzzViewing or downloading the Alert log

You can view the current Alert log or download the current Alert Log from the server to your workstation.

  1. Select Tools > Log Files.
  2. Click the file name link to view the Alert log. By default, only those lines of the log containing the name of your Operator ID appear. You can remove this filter or establish another filter.
  3. Click the Text or ZIP link to download the Alert log as a text file or zip file. You may be prompted for application server authentication credentials, if defined for the PegaDiagnosticUser role in the web.xml file. Consult the Installation Guide for more information and instructions.
  4. Import the file into Microsoft Excel, using a single asterisk character (*) as the field separator character, for ease in reading, sorting, or searching.
To see only those alerts produced by your own requestor session, select Tools > My Alerts.

 zzzAlert types

Process Commander includes thirty alert types. Threshold settings in the prconfig.xml file affect the operation and criteria of many alert types. For detailed information about every field reported by each alert type, consult the PDNAlerts Guide 5.4, a PDF document available on the Pega Developer Network.

The Alert log may contain any of the following alert types; the category description appears on the My Alerts display.

ID

Category

Message text and description

PEGA0001 Browser Interaction Browser interaction time has exceeded a threshold setting. See How to monitor interactive response times.
PEGA0002 DB Commit Time Database commit operation has exceeded a threshold setting. See How to detect lengthy PegaRULES database operations.
PEGA0003 DB Rollback Time Database rollback operation has exceeded a threshold setting. See How to detect lengthy PegaRULES database operations.
PEGA0004 DB Bytes Read Number of bytes received from the database has exceeded threshold. See How to monitor Storage Stream operations.
PEGA0005 DB Time Database query operation has exceeded an elapsed time threshold setting. See How to detect lengthy PegaRULES database operations.
PEGA0008 PRPC Started PegaRULES engine successfully started.
PEGA0009 PRPC Failed Start PegaRULES engine failed to initialize.
PEGA0010 Agent Disabled Agent processing disabled because of execution errors
PEGA0011 Service Total Time Services — One of five time thresholds was exceeded during a service execution See Testing Services and Connectors on the Integration page of the Pega Developer Network.
PEGA0016 Cache Reduced The number of records in the rule assembly cache, a personal cache, or a property conclusion cache has reached or exceeded about 75% of the limit specified in the prconfig.xml file; This causes the system to invalidate older entries in the cache, making room for newer ones. See Understanding caching.
PEGA0017 Cache Force Reduced The number of records in the rule assembly cache, a personal cache, or a property conclusion cache has reached or exceeded a limit specified in the prconfig.xml file. This causes the system to immediately invalidate older entries in the cache, making room for additions. See Understanding caching.
PEGA0018 PRThreads Limit Number of PRThreads has exceeded the threshold for a requestor.
PEGA0019 Long Requestor The master agent has detected a long-running requestor session. See How to detect long-running requestors.
PEGA0020 Connect Total Time A connector call to an external system has exceeded an elapsed time threshold. See How to detect lengthy connector executions and PDNTesting Services and Connectors, located on the Integration page of the Pega Developer Network.
PEGA0021 Declarative Page Memory The total of shared memory to store Node-scope declarative pages has exceeded a threshold. See More about Declare Page rules.
PEGA0022 Rule Cache Disabled The rules cache became disabled, typically by an administrator using the System Management Application.
PEGA0023 Rule Cache Enabled The rules cache became enabled, typically accomplished by an administrator using the System Management application.
PEGA0024 Loading Declarative Network Loading declarative network has exceeded an elapsed time threshold. See How to detect large declarative networks.
PEGA0025 Reading Blob Need Columns A list operation (for example, an Obj-Browse method) accessed properties within the Storage Stream (blob) column, that is, properties not exposed as individual columns.
PEGA0026 Database Connection Time The elapsed time taken to acquire a database connection exceeded a threshold. See How to detect long database connection waits.
PEGA0027 DB Rows Returned A list operation returned many rows. See How to detect database list operations that return many rows.
PEGA0028 JVM Garbage Collection Collection usage threshold exceeded for long-lived object memory pool. A garbage collection operation completed, but did not free sufficient virtual memory.
PEGA0029 HTML Stream Size An HTML stream sent to the browser exceeds 2,000 kilobytes (or another threshold setting). See How to detect large HTML streams.
PEGA0030 Requestor Limit The number of requestors on a system node exceeds 200 (or another threshold setting). See How to detect when the number of requestors exceeds the threshold.
PEGA0031 Stream Overwritten A generated HTML stream was overwritten without being sent to the browser client. See How to detect when a generated stream was overwritten but never sent.
PEGA0032 Invalidated Rules Rule change invalidated the specified threshold of entries in the Rule Assembly cache. See How to detect when a rule change invalidates many entries in the Rules Assembly cache.
PEGA0033 DB Query Length Database query length has exceeded the specified threshold See How to detect when the database query length has exceeds a specified threshold.
PEGA0034 Declare Index The number of declare indexes in a single interaction exceeded threshold. See How to detect when the number of declare indexes exceed a threshold.
PEGA0035 Clipboard List Size A Page List property contains more than a specified threshold number of elements. See How to detect when a Page List property has many elements.

For additional information about each alert type, see Pega Developer Network article PDNPRKB-25374 Performance Alerts, security alerts, and AES.

OldFour alerts appeared in V5.2 but do not appear in later versions:

ID

Message text and description

PEGA0006 Discontinued as of V5.4, now reported as PEGA0006
PEGA0013 Disabled as of V5.3, now reported as PEGA0011.
PEGA0014 Disabled as of V5.3, now reported as PEGA0011.
PEGA0015 Disabled as of V5.3, now reported as PEGA0011.

OldTwo alerts appeared in V5.3 but do not appear in later versions:

ID

Message text and description

PEGA0006 Database update operation has exceeded a threshold setting. See How to detect lengthy PegaRULES database operations. Reported as PEGA0005.
PEGA0007 Database operation has exceeded a threshold setting. See How to detect lengthy PegaRULES database operations. Reported as PEGA0005.

 zzzSummarizing the Alert log with the PegaRULES Log Analyzer

The PegaRULES Log Analyzer (PLA) is a Web application that can parse, consolidate and summarize alert logs.

For basic information on PLA, see PDNPDN articles PRKB-25406 Understanding the PegaRULES Log Analyzer and PRKB-25392 How to use the PegaRULES Log Analyzer.

 zzzParsing the Alert log with Excel

Fields in the Alert log are separated by an asterisk character. You can import the Alert log into Microsoft Excel for viewing, searching, sorting, or other analysis:

  1. Start Excel 2000 or a later version of Excel.
  2. Select File > Open from the Excel menus.
  3. Navigate to the PEGA-ALERT-ZZZZLOG file and click Open. The Text Import Wizard starts.
  4. Select the Delimited radio button in the Original data type group. Click Next.
  5. Select the Other check box and type a single asterisk as the delimiter. Click Finish.

Excel Import

TipAccess the Pega Developer Network to obtain the latest copy of the Alerts.XLS Excel template. This can speed and simplify parsing and summarizing Alert logs .

 zzzFormat of each alert line

Each line of the log contains multiple fields, delimited by a single asterisk character. Each line contains these fields. The first column identifies the Excel column after import.

Col

Field

Description

A Timestamp Date and time of the alert event in UTC format.
B Version "6" for Process Commander V5.4+. (Alert logs produced by 5.1 and 5.2 have "2" or "3" in this field, and fewer fields in each row.)
C Message ID Identifier of alert type, for example PEGA0011.
D KPI Value Observed duration in milliseconds or count of value, known as the key performance indicator.
E KPI Threshold Threshold value for this alert type, in milliseconds or count.
F ServerID Node ID for the node that is the source of the alert event.
G Requestor ID Session identifier; the first letter (A, B, H, or P) identifies the requestor type.
H User ID Operator ID of requestor, or none.
I Work pool Work pool that the requestor uses, or none.
J Encoded RuleSet Hash code identifying the requestors RuleSet list.
K Checkout Enabled Y indicates that the activity in the Activity field is in a personal RuleSet; that a developer has checked out the activity.
L Interaction number For alerts from browser sessions, the interaction number (as it appears on the Performance tool display).
M Sequence Sequence number for this alert in the log; unique within this log.
N Thread Internal name of the PRThread instance, or NA if this alert is not from a Thread.
O Logger Java class that produced the alert instance.
P Last Input For alerts from interactive requestors, a portion of the URL received in the most recent interaction. Typically the text Stream= or Activity= and the name of an activity or stream rule run by the URL.
Q First Activity For alerts from interactive requestors, the first activity or stream run by this requestor in the current interaction. (This activity or stream may or may not have caused the alert.)
R Last Step If the First Activity field identifies an activity, this field identifies the step number last completed, when available.
S Trace List Colon-delimited string containing the most recent 50 operations of this requestor before the alert event. Each operation consists of two subfields in the format number:value:.
T Reserved Reserved.
U PAL data For some Message ID types, a set of selected of Performance tool statistics at the time of the alert. A colon delimited string in the format propertyname:value:. Values are in milliseconds, bytes, or counts.
V Line A text description of the alert.

 zzzSecurity Alerts

Security alerts are recorded in the Security log.

ID

Category

Message text and description

SECU0001 Security Security alert; an HTTP request referenced an unexpected property. These can arise from an improperly coded URL JavaServer Page tag.
SECU0002 Security Security alert; an HTTP POST operation sent an XML document containing clipboard page details from a web node within a Pega Composite Application.
SEC0003 Security Security alert. A requestor on a web node, within a Pega Composite Application, attempted to execute an activity or list view rule that is not marked for web node execution. The attempt was ignored.
SEC0004 Security Security alert. A URL received from a web node, within a Pega Composite Application, contained the pyStream parameter. The URL was ignored.

 zzzNotes

The Alert log identifies the names of activities and other rules executed. By default for alerts of types PEGA0002 to PEGA0007, parameter values and SQL statements containing property values also appear. You can include the suppressInserts keyword in the prconfig.xml file so that parameter values and other potentially sensitive data values are omitted in prepared statement inserts:

  1. Add the following line to the prconfig.xml file:

<env name="alerts/database/operationTimeThreshold/suppressInserts" value="true" />

  2. Stop and restart or redeploy the system.

An appender setting in the prlogging.xml file determines the name and existence of the Alert log.

The Alert log supports the optional Autonomic Event Services component, which summarizes and monitors alerts across multiple nodes in a cluster.

See also these Pega Developer NetworkPDN articles:

Definitions appender, Autonomic Event Services, dependency network, Key Performance Indicator, master agent, Node ID, prconfig.xml file, prlogging.xml file, requestor type, rule cache, Thread, threshold, URL JSP tag, web node
Related topics Working with the My Alerts window
Understanding caching in Process Commander

zzzConcepts