Health check

The built-in health check reports the status of Conjur Servers (Leader and Standbys).

Overview

When you are scaling and managing Conjur, the health check helps you determine when Conjur Servers are up and ready for traffic. The health check reports the following information about a Conjur Server: 

  • Status of each service running on the Conjur Server.

  • Status of the internal database on the Conjur Server.

  • Status of replication.

  • Overall status of the Conjur Server.

Health check using the API

You can request health checks against any cluster node using the Conjur API. These routes do not require authentication.

For more information, see Health check.

Check follower health

Run the health route on a Follower to determine if that Follower is able to service requests. If the follower returns HTTP 200, or its status is ok in a curl response, it means that the Follower is operational.

 

A health check on a Follower does not reflect the status of the Leader. A Follower's status can be ok, meaning that it is available to service requests, even when the Leader is experiencing problems.

Health check in the UI

The Conjur UI shows a summary of health status for the nodes in a Conjur cluster. If you have a simple configuration with just one node, the UI shows the status of the single node.

In 5.2.3 and later, the UI does not show the health status of followers.

To see the health summary in the UI: 

  1. Log into the UI. See User interface.

  2. Click the Tools icon in the top right corner.

  3. Select Conjur Cluster.

    The window lists nodes and health for each one in the following categories: Services, Database, Replication Status, and Free Space. The Good status indicates healthy.