Health Check

Version history
  • Liveness and readiness probes were introduced in GitLab 9.1.
  • The health_check endpoint was introduced in GitLab 8.8 and was deprecated in GitLab 9.1.
  • Access token has been deprecated in GitLab 9.4 in favor of IP whitelist.

GitLab provides liveness and readiness probes to indicate service health and reachability to required services. These probes report on the status of the database connection, Redis connection, and access to the filesystem. These endpoints can be provided to schedulers like Kubernetes to hold traffic until the system is ready or restart the container as needed.

IP whitelist

To access monitoring resources, the requesting client IP needs to be included in a whitelist. For details, see how to add IPs to a whitelist for the monitoring endpoints.

Using the endpoints locally

With default whitelist settings, the probes can be accessed from localhost using the following URLs:

GET http://localhost/-/health
GET http://localhost/-/readiness
GET http://localhost/-/liveness

Health

Checks whether the application server is running. It does not verify the database or other services are running.

GET /-/health

Example request:

curl 'https://gitlab.example.com/-/health'

Example response:

GitLab OK

Readiness

The readiness probe checks whether the Gitlab instance is ready to use. It checks the dependent services (Database, Redis, Gitaly etc.) and gives a status for each.

GET /-/readiness

Example request:

curl 'https://gitlab.example.com/-/readiness'

Example response:

{
   "db_check":{
      "status":"failed",
      "message": "unexpected Db check result: 0"
   },
   "redis_check":{
      "status":"ok"
   },
   "cache_check":{
      "status":"ok"
   },
   "queues_check":{
      "status":"ok"
   },
   "shared_state_check":{
      "status":"ok"
   },
   "gitaly_check":{
      "status":"ok",
      "labels":{
         "shard":"default"
         }
      }
   }

Liveness

The liveness probe checks whether the application server is alive. Unlike the health check, this check hits the database.

GET /-/liveness

Example request:

curl 'https://gitlab.example.com/-/liveness'

Example response:

On success, the endpoint will return a valid successful HTTP status code, and a response like below.

{
   "db_check":{
      "status":"ok"
   },
   "redis_check":{
      "status":"ok"
   },
   "cache_check":{
      "status":"ok"
   },
   "queues_check":{
      "status":"ok"
   },
   "shared_state_check":{
      "status":"ok"
   },
   "gitaly_check":{
      "status":"ok"
   }
}

On failure, the endpoint will return a 500 HTTP status code.

Access token (Deprecated)

Note: Access token has been deprecated in GitLab 9.4 in favor of IP whitelist.

An access token needs to be provided while accessing the probe endpoints. The current accepted token can be found under the Admin area ➔ Monitoring ➔ Health check (admin/health_check) page of your GitLab instance.

access token

The access token can be passed as a URL parameter:

https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN