Instance Health

The Instance Health feature is currently available for Confluence and Jira.

What is Instance health?

Instance health checks your application for known issues. These health checks can return one of the following status:

IconMeaning
The health check has passed successfully. No action is required.
The health check has encountered an issue that may cause problems in the future. We recommend reviewing these messages, although remedial action may not be required.
The health check has encountered an error, or the health check has failed to perform. You should review these messages and take any appropriate remedial action.

When are health checks performed?

Checks are performed in real time, each time you visit the Instance Health tab in the Troubleshooting and support tools screen. 

In addition, scheduled checks are performed every hour since the instance's last start time. This means if you start Confluence at 3:15 PM, Confluence will perform a scheduled health check at 15 minutes past the hour, every hour, until the next restart. This interval can be adjusted by setting the atlassian.healthcheck.scheduler.interval-ms system property to the desired interval in milliseconds.

What happens when a health check fails?

Failed health checks are listed in the Instance Health tab.  Click each health check to find out why the check has failed and what do to to resolve the problem. Here's some examples of failing health checks. 

 

How do I know when a health check fails?

When you visit the Instance Health tab, the health checks run automatically and you'll see any problems detected listed. 

When a health check fails in the background, we notify Administrators the next time they visit any page in the application's administration console. 

The administrator can then take the following actions:

  • Find out more takes the administrator to the Instance Health screen to review the failed Health Check.
  • Don't remind me again will dismiss notifications of this type, until the problem occurs again.
  • The X icon will close the notification.

If you dismiss a notification three times, we won't notify you again for that particular check (this is the same as clicking the Don't remind me again link).

How can I select what types of failures that I'm notified about?

As well as dismissing particular notifications, each administrator can also select the level of notifications they would like to receive. The levels are:

  • Show all notifications
  • Only show notifications for major problems
  • Don't show any notifications

How do I disable a particular health check? 

There may be some instances where you don't want to run a health check at all. 

To disable a health check:

  1. Go to the Instance Health tab in Troubleshooting and Support Tools
  2. Expand the health check you want to disable.
  3. Deselect the Enable this check toggle. 

Disabled checks are listed at the bottom of the Instance Health tab, and won't be run until enabled. 

What health checks are available?

Not all checks are available in all applications, the table below provides some examples. We're adding new health checks all the time, so head to Instance health to find out which checks are running in your application. 

Health Check nameWhat does it check?Available in
License Expiry

Checks your license expiry date and provides a warning issued if your license expires in the next 30 days.

Jira applications and Confluence
Embedded DatabaseEnsures you're not using a HSQL or H2 Database with a production license key.Jira applications and Confluence
LuceneEnsures the Lucene index is working. Problems with the Lucene index will impact the ability to perform searches. Only runs on Confluence if you are using Lucene.Jira applications and Confluence
OpenSearchChecks the connection to the OpenSearch cluster as well as the health of the cluster. This check only runs if the Confluence instance is configured to use OpenSearch. Only runs on Confluence if you are using OpenSearch.Confluence
Confluence HomeEnsures that the home directory is readable and writeable.Jira applications and Confluence
Active ObjectsEnsures that Active Objects is installed and available.Jira applications and Confluence
End of LifeChecks if the running version of the application is approaching or has reached End of Life.Jira applications and Confluence
Lucene index files locationChecks if the Lucene search index directory is mounted on a network file system (NFS). Only runs on Confluence if you are using Lucene.Jira applications and Confluence
Open files limitChecks if the operating system's currently open files are close to the maximum limit.Jira applications and Confluence
Application Server and VendorEnsures you're using a supported application server.Confluence
Java Version and VendorEnsures you're using a supported version of the JDK/JRE.Confluence
Collaborative Editing ModeChecks that collaborative editing is on.Confluence
Internal Administrator UserIf using LDAP, checks if an enabled internal user directory is present, and if an enabled administrator user exists in this directory.Confluence
Thread LimitChecks the maximum number of processes (threads) the user account can run at the same time.Confluence
Required PluginsEnsures that all required plugins and modules are enabled.Confluence
Max Allowed Packets CheckEnsures your MySQL database is using an appropriately sized max_packets value. Only runs if you're using MySQL.Confluence
Character Set CheckEnsures your MySQL database is using the correct character set. Only runs if you're using MySQL.Confluence
Collation CheckEnsures your MySQL database is using the correct collation. Only runs if you're using MySQL.Confluence
Storage Engine Check

Ensures your MySQL database is using the correct storage engine. Only runs if you're using MySQL.

Confluence
InnoDB Log File SizeEnsures your MySQL database is using an appropriate InnoDB Log File size. Only runs if you're using MySQL.Confluence
Server SQL Mode

Ensures your MySQL database is using the correct sql_mode variable. Only runs if you're using MySQL.

Confluence
Clustered DatabaseChecks whether Confluence or Jira is using an Amazon Aurora database (unsupported on Server licenses). Only runs if you have a Server license.Jira applications and Confluence
Deprecated jTDS driverChecks whether Confluence is using the deprecated jTDS driver to connect to a Microsoft SQL Server database.Confluence
Synchrony ConnectivityChecks the connection between Confluence and Synchrony.Confluence
Connection settingsChecks if the database connection is configured as per our recommended settings.Jira applications
CollationChecks if the database and tables are configured using the required collation.Jira applications
Supported databasesChecks if your Jira instance is using a supported database model and version.Jira applications
Isolation LevelChecks if the SQL Server database is configured using the required isolation level. Only runs if you're using SQL Server.Jira applications
LDAP AuthenticationChecks if Jira is able to connect successfully to LDAP servers using the user and password provided in the User Directory configuration.Jira applications and Confluence
Crowd AuthenticationChecks if Jira is able to connect successfully to Crowd servers using the application name and password provided in the User Directory configuration.Jira applications and Confluence
Base URL for gadgetsChecks if Jira is able to access itself through the configured Base URL to ensure that dashboard gadgets will work.Jira applications
Free SpaceEnsures there is enough free space to backup and restore the index.Jira applications
Explicit Garbage CollectionChecks that you're using the recommended JVM startup parameters for explicit garbage collection.Jira applications
Cluster Index ReplicationEnsures that the index is being replicated across the cluster in a timely fashion.Jira Data Center
Cluster LockChecks that cluster wide locks are being properly released.Jira Data Center
Cluster SchedulerChecks that the task scheduler is running.Jira Data Center
Cluster Cache ReplicationChecks that the cache replication is working between all nodes in the cluster.Jira Data Center
Cluster Node Time SynchronisationChecks that the system time for all nodes in the cluster are synchronized.Jira Data Center

Secondary Storage: Attachments

Checks secondary storage for attachments is correctly configured.Jira Data Center
Secondary Storage: AvatarsChecks secondary storage for avatars is correctly configured.Jira Data Center
Secondary Storage: PluginsChecks secondary storage for plugins is correctly configured.Jira Data Center
Secondary Storage: Index SnapshotsChecks secondary storage for index snapshots is correctly configured.Jira Data Center
Fresh index snapshot existenceVerifies that the most recently modified index snapshot present in the shared home directory isn’t older than the configured maximum age.Jira Data Center
Security vulnerabilities

Checks if your application version is listed as an affected version for any critical security vulnerabilities published at www.atlassian.com/trust/security/advisories.

Jira applications, Confluence, and Bamboo
Duplicate user accounts

Scans all user directories for duplicate user accounts.

Jira applications
Mail QueueChecks that emails regularly leave the mail queue.Jira applications
Mail Error QueueChecks if an email has been sent to a recipient. If not, the email lands in a mail error queue.Jira applications and Confluence
License limit checkVerifies if you are approaching your license limit. It can be used as an early indicator, to ensure you do not exceed your license limit.Jira and Confluence
Local Backup Security Looks for backups in the local application storage and warns you if any backup files are found there.Jira and Bamboo
Last modified on Jul 4, 2024

Was this helpful?

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