How Should Logging Levels Be Set?

Products

• Clarity PPM On Premise

Issue/Introduction

• The logs are important in determining the root cause and capture common errors in Clarity.
• However, 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.
• Therefore, 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.

 

Environment

Clarity PPM

Resolution

1. Log in as a Clarity Administrator
2. Go to the CSA(NSA)  via URL: http(s)://<serverhostname>:8090
3. Click on the <serverhostname> Logs > Edit Configuration
4. For each server, the following Category components should not be to INFO,DEBUG,TRACE. Instead, it should be set to resemble the following:

Note: If 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'?
7. If checked, service(s) do not have to be restarted.
8. If it is not checked, service(s) have to be restarted

If expected logging is not working:

1. please 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

Additional Information

• KB000014961 - Quick summary guide to the log files: which files to provide to Clarity Support?
• 33655 - How to enable Debug logging in Advanced Reporting - Jaspersoft
• 135888 - How to get debug logs for Rally in Clarity
• 99202 - How to provide the xml, mpp and MSP Logs for Troubleshooting Clarity MSP Issues