Configure Jira logging

Owned by Service Account
Last updated: Oct 22, 2021 by Jonathan Muse
1 min read

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

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. 

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:

  1. Open JIRA_HOME/atlassian-jira/WEB-INF/classes/log4j.properties with your favorite text editor.
  2. 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 routines 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 cPrime 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.

See also