Logging Instructions
- Maria Fakas (Deactivated)
- Boris Berenberg
- Boris Berenberg - Atlas Authority (Unlicensed)
Capture and Provide Logs
Figure out why your notifications aren’t working or something went wrong. Set up Logging to find the cause of an issue.
Choose > System
Select System support > Logging and profiling to open the Logging page, which lists all defined log4j categories (as package names) and their current logging levels
Click on Configure to add logging for our classes
Put com.riadalabs.jira.plugins.notificationassistant for the Package name and DEBUG for the Logging level
Reproduce the issue you are facing and make sure to note the following and include them with your logs:
Name of the Notification that you are testing
Issue Keys of the issues which should be included in the Notification
Recipients is that should have gotten a notification
If possible, export the Notification and share the file with us as well
Provide us with a support zip as outlined at https://confluence.atlassian.com/support/create-a-support-zip-790796819.html
If you are using Jira Data Center, we need a copy of the logs from all of the nodes in your cluster.If you have not yet filed a support ticket, file it at https://atlasauthority.atlassian.net/servicedesk/customer/portal/1/group/1/create/1
If you restart Jira, this gets reset and you have to apply it again.
Permanent Logging
Add the following to your <JIRA INSTALL DIRECTORY>/atlassian-jira/WEB-INF/classes/log4j.properties file. Changes to this file require a restart of Jira for the changes to take effect.
# ---------------------
#
# NAFJ LOGGING STARTS
#
# Email logger
#
log4j.appender.NAFJEmailLog=com.atlassian.jira.logging.JiraHomeAppender
log4j.appender.NAFJEmailLog.File=nafj-email.log
log4j.appender.NAFJEmailLog.MaxFileSize=20480KB
log4j.appender.NAFJEmailLog.MaxBackupIndex=5
log4j.appender.NAFJEmailLog.layout=org.apache.log4j.PatternLayout
log4j.appender.NAFJEmailLog.layout.ConversionPattern=%d %t %p [%c{4}] %m%n
log4j.appender.NAFJEmailLog.Threshold=INFO
# Notification Manager logger
#
log4j.appender.NAFJManagerLog=com.atlassian.jira.logging.JiraHomeAppender
log4j.appender.NAFJManagerLog.File=nafj-manager.log
log4j.appender.NAFJManagerLog.MaxFileSize=20480KB
log4j.appender.NAFJManagerLog.MaxBackupIndex=5
log4j.appender.NAFJManagerLog.layout=org.apache.log4j.PatternLayout
log4j.appender.NAFJManagerLog.layout.ConversionPattern=%d %t %p [%c{4}] %m%n
log4j.appender.NAFJManagerLog.Threshold=INFO
#
# add entries for all NAFJ packages
#
log4j.logger.com.riadalabs.jira.plugins.notificationassistant.NotificationEmailHandlerImpl=INFO, NAFJEmailLog
log4j.additivity.com.riadalabs.jira.plugins.notificationassistant.NotificationEmailHandlerImpl=false
log4j.logger.com.riadalabs.jira.plugins.notificationassistant.NotificationManagerImpl=INFO, NAFJManagerLog
log4j.additivity.com.riadalabs.jira.plugins.notificationassistant.NotificationManagerImpl=false
#
# NAFJ LOGGING ENDS
#
# --------------------The logs will be at:
<JIRA_HOME>/log/nafj-email.log
<JIRA_HOME>/log/nafj-manager.log