Resolving TimeTracker Plugin Worklog Display Issues Due to Jira Safeguard Limits
Platform Notice: Data Center - This article applies to Atlassian products on the Data Center platform.
Note that this knowledge base article was created for the Data Center version of the product. Data Center knowledge base articles for non-Data Center-specific features may also work for Server versions of the product, however they have not been tested. 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
Users of the TimeTracker Plugin in Jira may encounter issues where not all worklogs are displayed in JQL queries or reports. This problem typically arises when the number of worklogs exceeds Jira's safeguard limits for indexing. This article provides a solution to adjust these limits, ensuring that all worklogs are properly indexed and visible in the TimeTracker Plugin.
Environment
Jira version 8.22.2 and above, with TimeTracker Plugin installed.
Diagnosis
If worklogs are stored in the Worklog table but do not appear in JQL queries or TimeTracker Plugin reports, it's likely due to Jira's indexing safeguard limits being exceeded. To diagnose, run a JQL query for worklogs. If some expected worklogs are missing, the issue is likely due to these safeguard limits.
Cause
Jira's safeguard feature, introduced in version 8.22.2, limits the number of issue-related entities (including worklogs) that are indexed. When these limits are exceeded, additional worklogs are not indexed, leading to their absence in JQL queries and third-party plugins like TimeTracker.
Solution
To resolve this issue, increase the safeguard limit for worklogs by setting a higher value for the jira.safeguards.indexing.issue.worklogs system property. Follow these steps:
- Navigate to JIRA_INSTALL/bin.
- Edit the setenv file (.bat for Windows, .sh for Linux).
- Change JVM_SUPPORT_RECOMMENDED_ARGS="" to include the new limit, e.g., JVM_SUPPORT_RECOMMENDED_ARGS="-Djira.safeguards.indexing.issue.worklogs=5000".
- Restart Jira.
After restarting, confirm the change by searching the startup logs for the updated safeguard value.
Note that excessively high limits can impact Jira's performance. It's recommended to test these changes in a staging environment first and find a balanced value.