Enabling Support Features

The Support tab on the Dataplane Reports » Administration page shows a number of key properties of your Jira and Dataplane instance. This information is particularly helpful to reference whenever working with Arsenale Support to debug and resolve a possible Dataplane issue.

Enabling Debug Logging

When working with Arsenale Support, you may be asked to enable Dataplane debug logging on this page to see and share more-verbose Dataplane status information. To enable this feature, click the Enabled checkbox next to the Debug Logging option. 

Logging to a Separate Dataplane Log File

By default, Dataplane log output is intermixed with all other Jira application log output in file JIRA HOME/log/atlassian-jira.log. When debugging Dataplane, it's often most useful to see the app's log output in this context, in order to understand what else was going on in Jira during Dataplane activity and error conditions.

But sometimes it can be useful to direct all Dataplane log output to its own, separate log file; for example, if the default Jira log is too noisy with information, or Dataplane itself is overwhelming the default Jira log with too much detail.

To direct Dataplane log output to its own log file:

1. Append the following statements to the bottom of file atlassian-jira/WEB-INF/classes/log4j.properties, located in your Jira installation directory. These changes create a dedicated JIRA HOME/log/dataplane.log file, with up to ten, 20MB log file rotations.

   #####################################################
   # Arsenale Dataplane - log output to "dataplane.log"
   #####################################################
   
   log4j.appender.dataplanelog=com.atlassian.jira.logging.JiraHomeAppender
   log4j.appender.dataplanelog.File=dataplane.log
   log4j.appender.dataplanelog.MaxFileSize=20480KB
   log4j.appender.dataplanelog.MaxBackupIndex=10
   log4j.appender.dataplanelog.layout=com.atlassian.logging.log4j.NewLineIndentingFilteringPatternLayout
   log4j.appender.dataplanelog.layout.ConversionPattern=%d %t %p %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} [%q{2}] %m%n
   log4j.appender.dataplanelog.layout.StackTracePackagingExamined=false
   log4j.appender.dataplanelog.layout.MinimumLines=6
   log4j.appender.dataplanelog.layout.ShowEludedSummary=false
   log4j.appender.dataplanelog.layout.FilteringApplied=true
   log4j.appender.dataplanelog.layout.FilteredFrames=@jira-filtered-frames.properties
   
   log4j.logger.com.arsenalesystems.dataplane = WARN, console, dataplanelog
   log4j.additivity.com.arsenalesystems.dataplane = false

2. After modifying the log4j.properties file, restart Jira to pick up the new logging configuration.