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.

Logging Level Settings tool

Updated on April 5, 2022

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.

When you change the logging level, the system adds an entry in the Pega log that includes your operator ID and the date and time of the change.

Logging level changes take effect immediately and remain in effect until the node is stopped, or until the level is changed again by using the Logging Level Settings tool. The prlog4j2.xml file is not updated. Logging operations on nodes other than the current node are not affected.

Log messages that are generated by the Log-Message method statement and oLog() calls in Java steps are written to the log files. The log message level for a particular message is determined by your code. The logging level that is set in the Logging Level Settings tool determines which messages are written to the log file.

Access the Logging Level Settings tool by clicking ConfigureSystemOperationsLogsLogging level settings.

Logging levels

Each level causes messages of that level and above to be written to the log file. Following are the possible logging levels, listed from highest (most severe) to lowest (least severe):

  • OFF – Turns off logging.
  • FATAL – Indicates severe errors that can cause the application to terminate.
  • ERROR – Indicates serious errors that might allow the application to continue running.
  • ALERT – Pega Platform -specific messages that indicate that a performance threshold has been exceeded, or that an event has occurred that has an adverse performance implication.
  • WARN – Indicates situations that might have an adverse performance implication.
  • INFO – Indicates that a run-time event, such as startup or shutdown, has occurred.
  • DEBUG – Indicates informational events useful for debugging.
  • ALL – Indicates that all messages are logged.

For example, if the logging level is set to ERROR, log messages with a severity of ERROR and FATAL are written to the log file.

Rulesets, class hierarchy, and loggers

A logging level can be set for a specific Java class or other logger category. Rulesets and Pega Platform class hierarchy are not relevant to logging. If you set logging events for an activity named Data-Party.Research and your system includes several activities of that name (in various rulesets and versions), if any of these activities are run on the current node, they might produce logged events.

  • Temporarily changing the logging level

    You can use the Logging Level Settings tool to support debugging by temporarily overriding the logging level settings in the prlog4j2.xml file for the current node.

  • Resetting the logging level for all loggers

    You can reset the logging level for all loggers to the settings in the prlog4j2.xml file. By resetting all loggers you avoid resetting loggers individually. This setting is useful when you have changed settings for several loggers during debugging and you want to set them back to their original values. All changes to logging levels that are made by any operator using the Logging Level Settings tool are reset.

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