Skip to main content

Visualizing your application performance

Suggest edit Updated on April 28, 2022

Pega Cloud offers application performance monitoring and analytics using a built-in Kibana feature that is deprecated for new clients beginning in October 2021. Clients with Kibana access can continue to use the tools for searching and organizing your Pega application log data which your application generates.

To use the My Pega Cloud portal, have the following:

  • Cookies enabled in your browser settings.
  • Cloud-admin role or Cloud-change role access privileges. Contact your Pega Cloud administrator to secure those. For more information, see Support user roles.
  • Your My Pega Cloud portal preferences configured. For details, see Configuring your portal preferences.

While no end date for Kibana access and support is announced, existing clients are encouraged to take advantage of the alternative ways that you can access your logs and monitor your application using your preferred log monitoring tool. These include:

You can view the following log files:

Log files

Log typeLog nameLog file nameDescription
Tomcatcatalina-logs-*catalina.outContains Tomcat server system information, such as:
  • Startup entries and shutdown entries
  • Hazelcast data and other third-party products that the server uses
  • Configuration settings
  • Performance settings
  • Caches
Pegaprpc-application-logs-* PegaRULES.logContains Pega system information, such as:
  • System errors
  • Exceptions (with stack trace statements)
  • Debug statements
  • Any messages not specified as alerts

This log includes Pega activity-related messages and standard rules-generated messages.

Performance alerts prpc-alert-logs-* PegaRULES-ALERT-YYYY-MMM-DD.logContains diagnostic messages for system events that exceed performance thresholds or for failures. Each message includes the following type of details:
  • Event description
  • Value that exceeded the threshold
  • Type of requestor (for example, browser)
  • Alert-triggering Pega activity or stream
The performance alert message name format is PEGAnnnn, where nnnn is the message ID of the system event that generated the alert.
Security alertsprpc-security-logs-* PegaRULES-ALERTSECURITY-YYYY-MMM-DD.logContains messages about alerts that are generated when security of a Pega web node server is at risk.

The security alert message name format is SECUnnnn, where nnnn is the message ID of the security event that generated the alert.

Memoryprpc-memory-logs-*prpc-memory-logs-YYYY-MM-DD.logContains diagnostic server memory information, such as:
  • Heap usage
  • Memory utilization use
  • Requestor counts
Security Eventsprpc-security-events-logs-*PegaRULES-SecurityEvent.log

Contains messages about security events that are generated by the Pega web node server. Each message includes the following information:

  • appName
  • eventCategory
  • eventType
  • ID
  • ipAddress
  • nodeID
  • outcome
  • tenantID
  • timestamp

Specific events might contain additional information, such as “message” or “failedOperator.”

DataFlowprpc-dataflow-logs-*PegaDATAFLOW.log

Contains messages from DataFlow logs. Each log event includes the following information:

  • timestamp
  • message payload
Gatewayprpc-gateway-logs-*PRPCGateway-*.logContains messages from PRPC Gateway.
Localhost accesslocalhost-access-logs-*Localhost_access_log..YYYY-MM-DD.txt

Contains messages for Pega application access. Each log event includes the following information:

  • Time stamp
  • Response time
  • Hostname
  • Source IP address

    Source IP address is the IP address of a device that initiates the connection to the server. It is not necessarily the IP address of the originator of a request. For a bastion host, it might be the IP address of that host. For an external request coming in through an Application Load Balancer or NAT gateway, it might be the IP address of the ALB/NAT gateway.

  • Command
  • Response code
  • Request path
  • Protocol version
SMA accesssma-access-logs-*SMA_access_log..YYYY-MM-DD.txt

Contains messages for SMA access. Each event includes the following information:

  • Source IP address
  • Timestamp
  • Command
  • Protocol version
  • Response code
  • Response time
Accessing your log files

To access your log files using Kibana, see My cloud setup article for the My Pega Cloud portal.

Creating visualizations of your log files

After you find the log file information that you need, you can represent the data graphically. The following preconfigured visualizations work best in the Pega Cloud environment:

  • App – Top 10 Exceptions: Displays a pie chart of the most frequent exceptions in the log file. Point to a portion of the chart to display the information the portion represents.
  • Log Levels: Displays a list of the most frequent five message types in the log file and the number logged for the specified reporting time period.
Creating a new visualization
  1. In the Environments section, click the environment name.
  2. In the Environment Details tab, analyze your logs with Kibana by clicking Analyze logs.
  3. Enter the credentials that were provided by Pega.

    Pega Platform displays the raw log data.

  4. In the left navigation pane, click the Log type menu, and then select the log that you want to view.
  5. On the toolbar, set the time reporting range for the log file:
    • To choose a predefined time range, select Quick, and then select an option.
    • To choose a relative start time, select Relative, and then select an option.
    • To choose an absolute time range, select Absolute, and then enter the start date in the From field and the end date in the To field.
  6. In the search bar at the top of the window, search for specific data within the log file by entering search terms.

    All log entries that match that term are displayed.

    • Use a wild card search, such as *error* or *warning*, to find all entries that match those terms.
    • Use exact terms, such as "heap", to search for entries that contain those terms.
  7. View additional details by clicking the arrow next to a log entry.
Opening an existing visualization
  1. On the screen toolbar, click Visualize.
  2. In the Open a saved visualization, enter the name of the visualization that you want to use in the search bar, and then press Enter. The system displays the visualization with your log data.

For more information about options for saving and exporting visualizations, see theKibana User Guide on the Elastic website.

Creating a visualization dashboard

You can display your visualizations on a dashboard for easier viewing.

  1. On the screen toolbar, click Dashboard.
  2. Add a visualization to the dashboard by clicking Add.
  3. Enter the name of your visualization in the search bar at the top of the screen.
  4. In the displayed list of visualizations that you created, select the visualizations that to include in the dashboard. You can expand or rearrange the visualizations on the dashboard, as necessary.
  5. On the toolbar next to the search field, click Save Dashboard.
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us