Rolling Logs in Clarity

Products

• Clarity PPM SaaS
• Clarity PPM On Premise

Issue/Introduction

Setting up logging in Clarity, how do the rolling logs backups work? 

Environment

All Supported Clarity Versions

Resolution

• Connect to Logs In Clarity - CSA - Server - Logs - Edit Configuration or
• In Clarity UI - security.logs page with admin user: <SERVERNAME>:<PORT>/niku/nu#action:security.logs - Logs - Edit Configuration
• Scroll down to Appenders
• In Max Backups you can see how many log backups are set for each appender. The default amount is 3
• You can edit this amount for each log you need, and also combine with Max File Size for more flexibility on how you would like your logs to be generated
• Once you edit this, you have to restart services for this change to be applied
• Before making any changes, ensure your server has enough disk storage space to accommodate the added logs
• The Clarity Log backups work this way: 
  • Example for default configuration of 5MB Max File Size and 3 Max Backups for ca.log 
  • This will be valid for all -ca logs, example with app-ca.log:
  • The app-ca.log will fill up to 5MB and then after that the log will be renamed to app-ca.log.1 and a new empty app-ca.log will be created for fresh entries
  • Once the logs need rolling again, they will be renamed to .2, .3 accordingly
  • After .3 is no longer needed it will be erased since the Max Backup number is 3

Note: If your logs are filling up too quickly, Broadcom Support recommends reviewing the current log configuration, removing any extra DEBUG / INFO entries that you may have set.

If there is a repeated error, address it in order to ensure the logs are not being filled rather than changing the configuration. The default log setup is typically well balanced and suits most customers