Health Check
- 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
With default whitelist settings, the probes can be accessed from localhost using the following URLs:
http://localhost/-/health
http://localhost/-/readiness
http://localhost/-/liveness
The first endpoint, health
, only checks whether the application server is running. It does not verify the database or other services are running. A successful response will return a 200 status code with the following message:
GitLab OK
The readiness and liveness probes will provide a report of system health in JSON format.
readiness
probe example output:
{
"queues_check" : {
"status" : "ok"
},
"redis_check" : {
"status" : "ok"
},
"shared_state_check" : {
"status" : "ok"
},
"db_check" : {
"status" : "ok"
},
"cache_check" : {
"status" : "ok"
}
}
liveness
probe example output:
{
"cache_check" : {
"status" : "ok"
},
"db_check" : {
"status" : "ok"
},
"redis_check" : {
"status" : "ok"
},
"queues_check" : {
"status" : "ok"
},
"shared_state_check" : {
"status" : "ok"
}
}
Status
On failure, the endpoint will return a 500
HTTP status code. On success, the endpoint
will return a valid successful HTTP status code, and a success
message.
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.
The access token can be passed as a URL parameter:
https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc