Visualizing your application performance
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.
- Allow cookies in your browser settings.
- Contact your Pega Cloud administrator for the cloud-admin role or cloud-change role access privileges. For more information, see Support user roles.
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:
- Accessing your external logs using an external Amazon S3 bucket
- Streaming your Pega logs to Splunk
- Downloading your logs through My Pega Cloud
You can view the following log files:
Log files
| Log type | Log name | Log file name | Description |
|---|---|---|---|
| Tomcat | catalina-logs-* | catalina.out | Contains Tomcat server system information, such as:
|
| Pega | prpc-application-logs-* | PegaRULES.log | Contains Pega system information, such as:
This log includes Pega activity-related messages and standard rules-generated messages. |
| Performance alerts | prpc-alert-logs-* | PegaRULES-ALERT-YYYY-MMM-DD.log | Contains diagnostic messages for system events that exceed
performance thresholds or for failures. Each message includes
the following type of details:
|
| Security alerts | prpc-security-logs-* | PegaRULES-ALERTSECURITY-YYYY-MMM-DD.log | Contains 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. |
| Memory | prpc-memory-logs-* | prpc-memory-logs-YYYY-MM-DD.log | Contains diagnostic server memory information, such as:
|
| Security Events | prpc-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:
Specific events might contain additional information, such as “message” or “failedOperator.” |
| DataFlow | prpc-dataflow-logs-* | PegaDATAFLOW.log | Contains messages from DataFlow logs. Each log event includes the following information:
|
| Gateway | prpc-gateway-logs-* | PRPCGateway-*.log | Contains messages from PRPC Gateway. |
| Localhost access | localhost-access-logs-* | Localhost_access_log..YYYY-MM-DD.txt | Contains messages for Pega application access. Each log event includes the following information:
|
| SMA access | sma-access-logs-* | SMA_access_log..YYYY-MM-DD.txt | Contains messages for SMA access. Each event includes the following information:
|
To access your log files using Kibana, see My cloud setup article for the My Pega Cloud portal.
Creating visualizations of your log filesAfter 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.
- In the Environments section, click the environment name.
- In the Environment Details tab, analyze your logs with Kibana by clicking Analyze logs.
- Enter the credentials that were provided by Pega.
Pega Platform displays the raw log data.
- In the left navigation pane, click the Log type menu, and then select the log that you want to view.
- 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.
- 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.
- View additional details by clicking the arrow next to a log entry.
- On the screen toolbar, click Visualize.
- 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 dashboardYou can display your visualizations on a dashboard for easier viewing.
- On the screen toolbar, click Dashboard.
- Add a visualization to the dashboard by clicking Add.
- Enter the name of your visualization in the search bar at the top of the screen.
- 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.
- On the toolbar next to the search field, click Save Dashboard.