Log files tool
In the Log files tool, you can view or download the current log files on the server node that you currently access. Analyzing log files helps you make informed decision when you manage your applications, as well as identify any issues. As a result, you deliver an application that runs correctly and avoid exposing your users to errors.
For on-premises environments, the available log files depend on the contents of the
prlog4j2.xml file for the current node. The log files can include:
- PEGA
- A text file that contains warnings, errors, and information messages about internal operations.
- ALERT
- Performance-related alerts that are triggered by prconfig settings, or implicit, default values. A text file with fields separated by a single asterisk character.
- ALERTSECURITY
- Alerts identified by the prefix SECU that suggest incorrect configuration of the Internet Application Composer facilities, or overt attempts to bypass system security features through URL tampering. For more information, see Performance alerts, security alerts, and AES on Pega Community.
- BIX
- Files that were created during an extract of operation rules by the optional Business Intelligence Exchange product.
- CLUSTER
- A file that includes information about the setup and run-time behavior of the cluster, and other information provided by the clustering technology.
- DATAFLOW
- A file that includes data flow events in the system, such as a number of running threads, a number of newly created threads, or a number of stopped threads.
- MOBILE
- A text file that includes information about running of your mobile application. You can
retrieve logs for a user that you select and specify how much information you want to
include in the file. For example, the file can include information about failures during
logging to a mobile application in an offline mode.
Failures of data synchronization of your mobile application are part of the PEGA0066 alert. For more information, see PEGA0066 alert: Mobile App Data-Sync Failure on Pega Community.
- PegaRULES-SecurityEvent
- A file that contains information about security-related events that occur in the system, such as login failure or a password change. When security-related events occur in unusually large numbers or in suspicious patterns, they might represent a security issue.
For relevant training materials, see a Reviewing log files module on Pega Academy.
- Viewing logs
Analyze information about your system by viewing log files. Log files gather data about internal operations, system performance, or security so that you can make informed decisions when you manage your applications.
- Downloading log files
To view your log files later or to share the logs with other team members, download the log files. As a result, you can analyze system performance at a time that is convenient for you.
- Viewing log files in an external log viewer
You can view log files using an external log viewer, such as Kibana. An external log viewer can help you visualize logs and monitor potential issues.
- Log levels for log categories
You can select which log messages your log files include by creating custom log categories and associating log levels with your categories.
- Creating log categories in Dev Studio
Structure log messages into categories by creating custom log categories. Grouping loggers into categories makes it easier to manage log levels of loggers, because you do not have to remember the names of individual loggers.
- Renaming Pega logs
If two or more Pega Platform servers are installed in a single application server instance, they write lines to a common Pega log file. To prevent this from occurring, you can change the name or path of the Pega log for a node by modifying the prlog4j2.xml file.
- Rolling a log file
You can update the prlog4j2.xml file or dynamic system setting to cause a new log file to be created at the start of each day or on a periodic basis, rather than only at startup. This is known as "rolling" the log file.
- Displaying node type in the log
You can optionally choose to display the system node type in the Pega Platform log.
- Generating logs for autopopulated properties
For more efficient debugging of autopopulated properties, generate logs that contain events connected with specific properties that you select. Consequently, the troubleshooting process is better targeted and you can more quickly identify and fix issues in your application.
Previous topic Troubleshooting long-lived clipboard pages Next topic Viewing logs