How to mark logs for easier troubleshooting in Jira Server
Platform notice: Server and Data Center only. This article only applies to Atlassian products on the Server and Data Center platforms.
Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
When troubleshooting errors from log files, it can be difficult to determine where to start the investigation due to the huge amount of information within the log file.
The logs can be marked before and after the problem occurs (or is reproduced) to help to narrow down the search scope.
Environment
All versions of Jira Core 7.x and 8.x
(inherited by Jira Software and Jira Service Management)
Solution
Mark the logs via the following steps:
- Navigate to
JIRA Administration >> System >> Logging and profiling >> Mark Logs(<baseURL>/secure/admin/ViewLogging.jspa)
- Mark the logs with "replication starts here"
- Replicate the problem
- Mark the logs again with "replication ends here"
The logs will have the following entry:
2016-05-06 11:22:31,180 http-nio-8712-exec-4 uri:/j712/secure/admin/ViewLogging!markLogs.jspa username:admin INFO admin 682x4670x1 1k1ukiz 10.60.3.51 /secure/admin/ViewLogging!markLogs.jspa [c.a.j.util.log.LogMarker]
***********************
replication starts here
***********************
2016-05-06 11:22:48,525 JiraTaskExectionThread-1 INFO admin 682x4705x1 1k1ukiz 10.60.3.51 /secure/admin/IndexReIndex.jspa [c.a.j.w.a.admin.index.IndexAdminImpl] Re-indexing started
2016-05-06 11:22:48,528 JiraTaskExectionThread-1 INFO admin 682x4705x1 1k1ukiz 10.60.3.51 /secure/admin/IndexReIndex.jspa [c.a.j.util.index.CompositeIndexLifecycleManager] Reindex All In Background starting...
...
2016-05-06 11:22:50,828 JiraTaskExectionThread-1 INFO admin 682x4705x1 1k1ukiz 10.60.3.51 /secure/admin/IndexReIndex.jspa [c.a.j.w.a.admin.index.IndexAdminImpl] Re-indexing finished
2016-05-06 11:23:00,104 http-nio-8712-exec-19 uri:/j712/secure/admin/ViewLogging!markLogs.jspa username:admin INFO admin 683x4735x1 1k1ukiz 10.60.3.51 /secure/admin/ViewLogging!markLogs.jspa [c.a.j.util.log.LogMarker]
*********************
replication ends here
*********************All log files under $JIRA-HOME/log/ are marked simultaneously, as well as the $JIRA-INSTALL/logs/catalina.out file.
For more info, please see Useful log files in Jira.