Jive admin users are able to use the admin console to increase logging levels in order to troubleshooting issues that may be happening on an instance. The logging overrides for a site are managed in Admin Console: System > Management > Logging Management - Our documentation on this feature can be read here:
The purpose of this document is to outline some of the best practices around setting logging level overrides and how they can impact your Jive site.
- Verified for versions: Jive 5, 6, 7
Changing the logging levels
You can change the default logging level for the entire site by using the following dropdown
You can set the logging level override for a specific class by using the following text field and level dropdown:
For example, if you want to set a DEBUG level override for com.jivesoftware.ps.nitro.client you would use the following settings:
Applying the Override will create a new yellow row in the bottom half of the screen:
Knowing what class or package to add an override for
When creating a logging override rule you can apply it to either a class or a package in the Jive application code base. During the troubleshooting process Jive support may provide you a series of classes or packages to create overrides for. If you have questions around what overrides to use when troubleshooting a problem please create a support case and we can provide that information for you.
Increasing the logging levels can add a significant amount of output to the application's server logs. Although this may be necessary for troubleshooting a specific issue, it can be unintended consequences:
- The logs may be "noisy" and hard to parse given the additional logging output
- The logs may be written to more frequently, causing additional strain on the storage facility where the logs are located
- The logs may get rotated out at a faster rate, making it harder to find older logging output
- The logs may increase in size at a much faster rate than expected and can cause storage issue if not accounted for
- Only set logging overrides for a temporary amount of time - Logging overrides should not be set permanently.
- Avoid changing the global logging level override unless it is for development purposes or done in off-peak hours. This should be a very rare occurrence.
- Remember to always set the logging levels back to default after testing has been completed
Jive Hosting Notifications
If you have a site hosted with Jive, and Jive is alerted that your site has custom logging overrides set, Jive will reach out to you in your MyJive support group to coordinate removing these overrides in order to ensure that your logging overrides do not negatively impact the performance of your site. Jive may also change these logging settings if it looks like the overrides were accidentally left enabled or are no longer in use.