Health check: Storage index snapshot

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

Overview

To keep a copy of the recent state of the index, Jira creates a search index snapshot. This helps ensure that in a failover scenario, the node that takes over from the failed node can quickly acquire the most recent possible index without the need for a full re-indexing operation. The index snapshot storage health check verifies the snapshot storage configuration for problems that may prevent the backup and recovery of the search index.


Health check results 

IconResultWhat this means

All checks have passed successfully.

No storage issues for the index snapshot have been detected.

Couldn’t calculate the amount of required free space because the index snapshot directory (<directory>) doesn't exist.

There was a problem with accessing or locating the reported directory.

The storage device containing the temporary directory (<directory>) is low on disk space (<remaining_size> left). Make sure that the amount of free space is double the estimated size of the index (<estimated_index_size>).

There isn’t enough disk space available in the reported directory.

The storage device containing the snapshot directory (<directory>) is low on disk space (<remaining_size> left). Make sure that the amount of free space is double the estimated size of the index snapshot (<estimated_index_size>).

There isn’t enough disk space available in the reported directory.

Jira can’t write to the snapshot directory (<directory>). Check directory access permissions.

Jira was unable to create an empty file in the snapshot directory. Creating an index snapshot may also fail.

The name of the file Jira creates for the purpose of this check follows the convention of IndexSnapshotFileSystemUtil
_testFile_<time_in_ms>
_<node_id>
. The file should be automatically deleted after the health check is complete. If it’s not, you can safely delete it manually.

Resolution

Here’s what you can do depending on the reason why the health check has failed in your system:

Couldn’t calculate the amount of required disk space

Ensure that Jira has permission to read from and write to the snapshot directory.

The storage device is low on disk space

The available storage space in the reported directory is lower than the required amount. Make sure that the amount of free disk space is at least twice the size of your current working index. You should also allow for the growth of the index over time.

Jira can’t write to the snapshot directory

Ensure that Jira has permission to write to the snapshot directory.

Lucene search is not available

Contact Atlassian Support providing the information listed in “Requesting support”.


Providing Information to Support

In case you are unable to troubleshoot and fix the problem by yourself, please create a support ticket at support.atlassian.com and attach the following information to the ticket:

  • Take a Screenshot of the Health Check results.
  • Collect a Support ZIP from each of the Data Centre nodes.
  • Any collected information from the suggestions in this document.


In the event that the directory is reported as missing but does exist on the file system: 

Please provide details of the affected file System location [directory] showing ownership. This can be achieved  through the following steps:
  • Linux

    ls -lahR [directory] | gzip -9 > fileListing.gz
  • Windows

    Use the AccessEnum SysInternals tool by Microsoft to complete this task, and collect a screenshot showing the permissions of the Shared Directory being used.


Last modified on Oct 3, 2023

Was this helpful?

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