What is Instance health?
Instance health checks your application for known issues. These health checks can return one of the following status:
|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 24 hours 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 3:15 PM every day until the next restart. This interval cannot be adjusted at this time.
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
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 name||What does it check?||Available in|
Checks your license expiry date and provides a warning issued if your license expires in the next 30 days.
|JIRA applications & Confluence|
|Embedded Database||Ensures you're not using a HSQL or H2 Database with a production license key.||JIRA applications & Confluence|
|Lucene||Ensures the Lucene index is working. Problems with the Lucene index will impact the ability to perform searches.||JIRA applications & Confluence|
|Confluence Home||Ensures that the home directory is readable and writeable.||JIRA applications & Confluence|
|Active Objects||Ensures that Active Objects is installed and available.||JIRA applications & Confluence|
|End of Life||Checks if the running version of the application is approaching or has reached End of Life.||JIRA applications & Confluence|
|Lucene index files location||Checks if the Lucene search index directory is mounted on a network file system (NFS).||JIRA applications & Confluence|
|Open files limit||Checks if the operating system's currently open files are close to the maximum limit.||JIRA applications & Confluence|
|Application Server and Vendor||Ensures you're using a supported application server.||Confluence|
|Java Version and Vendor||Ensures you're using a supported version of the JDK/JRE.||Confluence|
|Collaborative Editing Mode||Checks that collaborative editing is on.||Confluence|
|Internal Administrator User||If using LDAP, checks if an enabled internal user directory is present, and if an enabled administrator user exists in this directory.||Confluence|
|Thread Limit||Checks the maximum number of processes (threads) the user account can run at the same time.||Confluence|
|Required Plugins||Ensures that all required plugins and modules are enabled.||Confluence|
|Max Allowed Packets Check||Ensures your MySQL database is using an appropriately sized
|Character Set Check||Ensures your MySQL database is using the correct character set. Only runs if you're using MySQL.||Confluence|
|Collation Check||Ensures 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.
|InnoDB Log File Size||Ensures 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.
|Deprecated jTDS driver||Checks whether Confluence is using the deprecated jTDS driver to connect to a Microsoft SQL Server database.||Confluence|
|Connection settings||Checks if the database connection is configured as per our recommended settings.||JIRA applications|
|Collation||Checks if the database and tables are configured using the required collation.||JIRA applications|
|Supported databases||Checks if your JIRA instance is using a supported database model and version.||JIRA applications|
|Isolation Level||Checks if the SQL Server database is configured using the required isolation level. Only runs if you're using SQL Server.||JIRA applications|
|Base URL for gadgets||Checks if JIRA is able to access itself through the configured Base URL to ensure that dashboard gadgets will work.||JIRA applications|
|LDAP Authentication||Checks if JIRA is able to connect successfully to LDAP servers using the user and password provided in the User Directory configuration.||JIRA applications|
|Free Space||Ensures there is enough free space to backup and restore the index.||JIRA applications|
|Cluster Index Replication||Ensures that the index is being replicated across the cluster in a timely fashion.||JIRA Data Center|
|Cluster Lock||Checks that cluster wide locks are being properly released.||JIRA Data Center|
|Cluster Scheduler||Checks that the task scheduler is running.||JIRA Data Center|
|Cluster Cache Replication||Checks that the cache replication is working between all nodes in the cluster.||JIRA Data Center|
|Cluster Node Time Synchronisation||Checks 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: Avatars||Checks secondary storage for avatars is correctly configured.||JIRA Data Center|
|Secondary Storage: Plugins||Checks secondary storage for plugins is correctly configured.||JIRA Data Center|
|Secondary Storage: Index Snapshots||Checks secondary storage for index snapshots is correctly configured.||JIRA Data Center|