Improved indexation for issue-related entities

JRASERVER-73874 - Getting issue details... STATUS

Starting from 8.22.2 (backported to 8.20.12), Jira will index only topN of the following issue-related entities: comments, changehistory, and worklog. Any reindexing operation that triggers full issue reindex, including full foreground reindex and indexer#reindex(issue, all), will reindex a limited number of topN of related entities. The topN value can be any integer.

This feature is enabled by default with the following limits set to related entities (comments, changehistory, and worklog):

Based on specific use cases, Jira admins can change default topN values for these entities by setting a Java property to the desired limit. System property names for issue entities:

• For comments: jira.safeguards.indexing.issue.comments
• For change history items: jira.safeguards.indexing.issue.changelogs
• For worklogs: jira.safeguards.indexing.issue.worklogs

It’s also possible to disable the feature by setting the corresponding system property to -1.

For example on how to change one of these properties, please refer to the KB article How to change Indexing Limit Safeguards in Jira.

Introducing limits to change items indexing 

Jira 8.22.3 also introduces updates to the way indexing works. In this release, we’ve extended the functionality of Safeguards in Jira index that changes the default behavior of change items indexing.

Change items with unsupported fields will be filtered out before they’re collected into change groups. As a result, when there’s a group of change items with unsupported fields only, it won’t be indexed. So, no document will be created for it in the database.

The feature is enabled by default with the limit of six fields in the change items index:

• Assignee
• Fix Version
• Priority
• Reporter
• Resolution
• Status

In specific use cases, Jira administrators can change the default behavior. For example, when there’s a need to use the UpdatedBy JQL function, Jira administrator can configure the following system property:

jira.safeguards.indexing.issue.changelogs.do.not.filter.out.unsupported.fields

Consider the following:

• If this system property isn’t set up, change items with unsupported fields will be filtered out. This is the default behavior.
• If this system property is set to "true", unsupported fields won’t be filtered out.
• The number of indexed change groups will be limited to DEFAULT_INDEXING_LIMIT.
• To enable the old search functionality for historical changes, use the mentioned system property along with jira.safeguards.indexing.issue.changelogs (it defines how many groups should be indexed).