Worklog indexing

Owned by
Dan Mihalache
Last updated: Jun 05, 2024 by
Praveena Manohar
3 min read

Rich Filters::Time Tracking Dashboards is an extension of the Rich Filters for Jira Dashboards app. 

Because it operates at the worklog level, Rich Filters::Time Tracking Dashboards needs to index the work logs on your instance after it is installed or upgraded. Otherwise, rich filter statistics and queries on work logs might not work correctly. Jira’s native background re-index (global or per project) does not re-index the work logs, it indexes only the issues. This is why the app provides a Worklog indexing page, which allows you to re-index the work logs.

Only Jira Administrators have access to the Worklog indexing page, which is accessible from Jira’s Add-ons administration menu under the Rich Filters section.

image-20240605-152116.png
image-20240605-152147.png

 

If the Keyboard Shortcuts feature is enabled on your Jira instance, you can also use the “gg” shortcut and type 'Worklog indexing' in order to quickly find the page. (On newer Jira versions, pressing “.” opens the same menu.)



Limits on the number of work logs indexed per issue

Starting with Jira versions 8.20.12, 8.22.2, and 9.0, Jira, by default, limits the maximum number of worklogs indexed per issue – you can find more details on this topic in the Introducing Safeguards to Jira index knowledge base article.

In order to ensure accurate results, Rich Filters::Time Tracking Dashboards need to be able to index all the worklogs. If your Jira instance limits the number of worklogs per issue and if this limit exceeds your issues, you need to increase or disable the limit on the number of worklogs indexed by updating the jira.safeguards.indexing.issue.worklogs system property – detailed instructions are available in the How to change Indexing Limit Safeguards in Jira knowledge base article.

To re-index the work logs, the Worklog indexing page provides two possible options: 

  1. Lock Jira and rebuild index
    This option builds the index from scratch, both for the issues and work logs, but Jira will be unavailable to all users until the re-index is complete. It's worth mentioning that this option is simply a redirect to Jira's native 'Lock Jira and re-build index' operation, which indexes both issues and work logs (unlike Jira's native background re-index, which indexes only the issues).

  2. Re-index work logs in background
    We provide this tool to re-index the work logs for some of the projects. This option runs in the background, and the users can access Jira during the re-index. This option is ideal if you’re evaluating Rich Filters::Time Tracking Dashboards and want to build time-tracking dashboards on some projects.