How to Enable Detailed JQL Logging in JIRA

Still need help?

The Atlassian Community is here for you.

Ask the community

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

Purpose

This KB article instructs how to enable detailed JQL logging inside of JIRA. This can be used for any of the following:

  • Understanding what JQL is submitted for different actions (such as gadgets, JIRA Software boards and so on)
  • Reverse-engineering GUI actions to determine what JQL is submitted for certain user actions or searches

Solution

  1. Log into JIRA as an Administrator.
  2. Go to Administration > System > Troubleshooting and Support > Logging and Profiling.

  3. Search for com.atlassian.jira.issue.search.providers and set it to DEBUG:


    (info) The resulting logs will be in <JIRA HOME>/log/atlassian-jira.log.


These settings will be lost on restart, as they're stored in memory. To have JIRA persist the settings they can be changed in the log4j.properties file. For example:

log4j.logger.com.atlassian.jira.issue.search.providers = WARN, console, debug
Last modified on Dec 9, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.