Health check: OpenSearch Mappings Limit in Jira Data Center
Platform Notice: Data Center Only - This article only applies to Atlassian apps on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs 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
In OpenSearch, mappings define how documents and their fields are stored and indexed. Each field in Jira, whether a system field or a custom field, is mapped as an index field to enable search functionality. As you create more custom fields in Jira, the size of these mappings can grow, which might impact the performance and memory usage of your OpenSearch cluster.
OpenSearch provides several settings to help maintain cluster performance and prevent memory issues caused by creating an excessive number of fields. One such setting is index.mapping.total_fields.limit, which sets the maximum number of fields allowed in an OpenSearch index (the default is 1000).
This health check verifies if the current number of fields is approaching this limit.
Solution
Understand the Health Check results
Icon | Result | What this means |
✅ | The OpenSearch index has | The current limit is sufficiently high. |
⚠️ | The OpenSearch index has | The number of fields is approaching the |
❗ | The OpenSearch index has reached its field mapping limit ( | The |
⚠️ | Unable to assess the OpenSearch index mappings or limit. | There was a problem checking the OpenSearch index mappings or settings. |
Troubleshooting
Problem | Suggestion |
The number of fields is approaching the mappings limit | Increase the Use an index template to make sure that this setting is applied permanently, even after you rebuild the index. For more details, see Configuring index settings on OpenSearch. Please note: Increasing this limit requires careful consideration of cluster resources. Note that once a field is created in OpenSearch mappings, it can’t be deleted. To clean up stale mappings, you need to perform a re-index. Explore how to re-index Jira |
The | Increase the Use an index template to make sure that this setting will be applied permanently, even after you rebuild the index. For more details, see Configuring index settings on OpenSearch. Please note: Increasing this limit requires careful consideration of cluster resources. Some fields might have failed to be created due to hitting this limit. You can verify this by checking the Missing OpenSearch Mappings health check. In such case, perform a re-index after increasing the fields limit. Explore how to re-index Jira |
There was a problem checking the OpenSearch index | Check logs for errors. Some possible reasons are network connectivity issues or lack of permissions. For more details, see Securing an OpenSearch cluster. |
Was this helpful?