Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Log files tool

Updated on April 5, 2022

In the Log files tool you can view or download the current log files on the server node you are accessing.

Access this tool by clicking ConfigureSystemOperationsLogs.

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 the Pega Community article Performance alerts, security alerts, and AES.
  • 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.
  • Viewing logs

    View the log files to see the completion status for operations. The log files match the current operator ID for all the sessions on the server node.

  • Downloading log files

    You can save your log files to view them later.

  • 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 log categories and associating log levels with your categories.

  • Creating log categories

    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.

  • Logging Level Settings tool

    You can use the Logging Level Settings tool to temporarily override the severity settings in the prlog4j2.xml file for the current node and control which logging events are displayed in the Pega log. For example, you can change the logging level for activities in the Work- class from FATAL to DEBUG for troubleshooting purposes.

  • 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.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us