Jira Logging Configuration
- Jonathan Muse
- Shane Smith
Configure Jira Logging
There are two ways of configuring logging for our apps. One is permanent, and survives Jira restarts, the other is just temporary and is reset either from the Jira's UI or at the next restart.
NEW In-App Logging Configuration Quick Change
In addition to the 2 methods describe below, there is a new faster way to change the logging level for Power Scripts (and the other Power Apps). This quick apply configuration is similar to the temporary configuration described below.
Navigate to Jira Admin > Manage Apps
Navigate to the Power Apps Configuration page
Go to the Runtime menu
Go to the SIL Diagnostic sub-menu
Click the “Set log level to DEVUG for Anova addons” button to temporarily change the logging to DEBUG
Uncheck the configuration setting when enough log messages have been collected
Permanent Jira Logging Configuration
Jira uses Log4J as a logging system. All our apps are written such as debug information, if needed, can be easily extracted from them. In the same time, our apps may produce useful informational messages, and we recommend to keep the logging level to INFO, so you can examine them. To permanently configure logging:
Open JIRA_HOME/atlassian-jira/WEB-INF/classes/log4j.properties with your favorite text editor.
Append the following lines. Add them at the end
log4j.category.com.keplerrominfo = INFO, console, filelog
log4j.additivity.com.keplerrominfo = false
Note
If you do not perform this configuration step, certain functions such as print() may not output messages.
DEBUG Information
For debug information make sure these 2 lines are in JIRA_HOME/atlassian-jira/WEB-INF/classes/log4j.properties file
log4j.category.com.keplerrominfo = DEBUG, console, filelog
log4j.additivity.com.keplerrominfo = false
Warning
Setting the level to DEBUG outputs lots of messages and it may affect your performance. Do this only when instructed by Appfire Team. Keep this as brief as possible, for example when not necessary, move it back to INFO level
Temporary Jira Logging Configuration
Jira offers a nice facility for logging, and you may configure the logging for com.keplerrominfo package to any level you want: DEBUG, INFO, WARN, ERROR. For more information see Jira Documentation: Logging and Profiling.