How to enable debug logs for Composition Tabs for Confluence

Purpose

This KB provides the guide on how to enable debug logs for the Composition Tabs for Confluence app.

This guide only applies to Composition Tabs for Confluence Data Center (not Cloud).

Solution

In Composition Tabs for Confluence Data Center we have implemented a logging feature which can be useful for troubleshooting complex issues you may have with the app.

To help us troubleshoot any performance issues you may have, follow the following steps

Go to the ⚙ (gear icon) > General Configuration > In the sidebar, under Administration, choose Logging and Profiling
On the Logging and Profiling screen, you need to Add a New Entry
- Add net.customware.confluence.plugin.composition as a new entry in Class/Package Name
- Set the New Level to DEBUG
- Choose Add entry
- Scroll down and choose Save
Load the page where you are experiencing issues with the app
Generate the support zip

Ensure there are no preceding or trailing spaces or any other characters in the net.customware.confluence.plugin.composition string.

You can find the log file here: <confluence-installation>/home/logs/atlassian-confluence.log

Removing the Debug Entry

After saving the log file, you may, for any reason, want to disable the logging.

Here's how to do it:

Return to the Logging and Profiling screen
Locate the net.customware.confluence.plugin.composition entry
Choose Remove

The Debug Entry is also removed automatically if the Confluence instance is restarted.