LinkedIn
Copied!

Table of Contents

Accessing server logs by using Kibana

Pega Cloud Services gives you the capability to view your server logs for analysis and tracking purposes. This service is built on the Kibana platform, which provides tools for searching and organizing the data.

The following log files are available for viewing:

Log files

Log type Log name Log file name Description
Tomcat catalina-logs-* catalina.out Contains Tomcat server system information, including:
  • Startup entries and shutdown entries
  • Hazelcast data and other third-party products that the server uses
  • Configuration settings
  • Performance settings
  • Caches
Pega prpc-application-logs-* PegaRULES.log Contains Pega system information, including:
  • System errors
  • Exceptions (with stack trace statements)
  • Debug statements
  • Any messages not specified as alerts

This log includes Pega activity-related messages, as well as 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:
  • Event description
  • The value that exceeded the threshold
  • Type of requestor (for example, browser)
  • The alert-triggering Pega activity or stream
The performance alert message name format is PEGAnnnn, where nnnn is the message ID of the system event which generated the alert.
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 which generated the alert.

Memory prpc-memory-logs-* prpc-memory-logs-YYYY-MM-DD.log Contains diagnostic server memory information, including:
  • Heap usage
  • Memory utilization
  • Requestor counts
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:

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

Specific events may contain additional information (such as “message” or “failedOperator”).

DataFlow prpc-dataflow-logs-* PegaDATAFLOW.log

Contains messages from DataFlow logs. Each log event includes:

  • timestamp
  • message payload
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:

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

    Source IP address is the IP address of 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 may be the IP address of that host, whereas for an external request coming in through an Application Load Balancer or NAT gateway, it may be the IP address of the the ALB/NAT gateway.

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

Contains messages for SMA access. Each event includes:

  • Source IP address
  • Timestamp
  • Command
  • Protocol version
  • Response code
  • Response time

Accessing your log files

For information about accessing your cloud environments, such as the logging URL and login credentials for each environment, refer to the email that you received from Pegasystems notifying you that your cloud environments are ready.

  1. In the environment for which you want to review logs, click the logging URL.
  2. Enter the credentials that were provided by Pegasystems. Pega Platform displays the raw log data.
  3. In the left navigation pane, click the Log type menu to select the log that you want to view.
  4. On the screen toolbar, click the time option to set the time reporting range for the log file.
    • Quick - Select an option from the list, such as Week to date.
    • Relative - Enter the relative start time.
    • Absolute - Enter the start date in the From field and the end date in the To field.
  5. To search for specific data within the log file, enter search terms into the search bar at the top of the screen. 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.
  6. Click the arrow next to a log entry to see additional details.
Creating graphical visualizations of your log files

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

  • App – Top 10 Exceptions - Displays a pie chart of the top exceptions in the log file. If you point to a portion of the chart, the information that is represented by that portion is displayed.
  • Log Levels - Displays a list of the top five message types in the log file and the number logged for the specified reporting time period.
  1. On the screen toolbar, click Visualize.
  2. In the Open a saved visualization section, type the name of the visualization that you want to use in the search bar and press Enter. The visualization with your log data is displayed.

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

Creating a 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 into the search bar at the top of the screen. A list of visualizations that you have created is displayed.
  4. From the list, select the visualizations that you want 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.
Suggest Edit

Have a question? Get answers now.

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