Set/Reset logging levels in Clarity

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

The logs are important in determining the root cause and capture common errors in Clarity. There can be too much logging, which clutters or overwrites errors that matter to a particular issue. On the other hand, there can be too little logging. Here are the best practices on setting the Clarity logging levels to make sure there is enough logging in the event there is an error or exception.

Resolution

Reset Logging to Default

1. Log in as a Clarity Administrator
2. Go to the CSA(NSA)
3. Click on Server - Logs - Edit Configuration
4. For each server, the default configuration can be set by clicking the button(Restore Default Logger Configuration)
   

Add DEBUG on a Component

1. Go to the CSA(NSA)
2. Click on Server - Logs - Edit Configuration
3. In the list of Categories, click Add Category
4. For Name in the drop down menu pick the Category requested by Support
5. Set the Appender to STDOUT
6. Set the Priority to DEBUG
7. Repeat on all servers in cluster
8. If Detect Log Configuration Changes Automatically is not set, restart all services

Note: If an additional component is needed that is not listed in the 'Name' dropdown menu:

1. Go to the Categories section
2. Click the button(Add Category)
3. Add the component in the 'Other Name' column.
4. Click Save.
5. Do this for each additional component.
6. Is there a checkmark on 'Detect Log Configuration Changes Automatically'?
   If checked, service(s) do not have to be restarted.
   If it is not checked, service(s) have to be restarted

If expected logging is not working:

Replace the logger.xml file:

1. Backup the file $CLARITY_HOME/config/logger.xml
2. Replace  $CLARITY_HOME/config/logger.xml with $CLARITY_HOME/.setup/templates/config/logger.xml
3. Restart the services

Important: Once you reproduce the issue and collect logs for Support, the DEBUG logging must be removed. DEBUG logging should only be used temporarily for collecting log evidence for an issue and not continuously

Additional Information

The exact categories have to be requested to be set by Broadcom Clarity Support

See also: Get Clarity logs from Security.logs in UI