2016-09-25 06:16:14 -04:00
|
|
|
# Health Check
|
|
|
|
|
2018-09-06 12:52:18 -04:00
|
|
|
> **Notes:**
|
|
|
|
> - Liveness and readiness probes were [introduced][ce-10416] in GitLab 9.1.
|
|
|
|
> - The `health_check` endpoint was [introduced][ce-3888] in GitLab 8.8 and will
|
|
|
|
> be deprecated in GitLab 9.1. Read more in the [old behavior](#old-behavior)
|
|
|
|
> section.
|
|
|
|
> - [Access token](#access-token) has been deprecated in GitLab 9.4
|
|
|
|
> in favor of [IP whitelist](#ip-whitelist)
|
2017-04-25 05:19:43 -04:00
|
|
|
|
|
|
|
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][kubernetes] to hold
|
|
|
|
traffic until the system is ready or restart the container as needed.
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
## IP whitelist
|
2017-07-03 16:41:33 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
To access monitoring resources, the client IP needs to be included in a whitelist.
|
2017-07-03 16:41:33 -04:00
|
|
|
|
2017-09-29 23:02:42 -04:00
|
|
|
[Read how to add IPs to a whitelist for the monitoring endpoints][admin].
|
2017-07-11 10:30:20 -04:00
|
|
|
|
2018-07-27 15:19:51 -04:00
|
|
|
## Using the endpoints
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-03 16:41:33 -04:00
|
|
|
With default whitelist settings, the probes can be accessed from localhost:
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2018-07-27 15:19:51 -04:00
|
|
|
- `http://localhost/-/health`
|
2017-07-03 16:41:33 -04:00
|
|
|
- `http://localhost/-/readiness`
|
|
|
|
- `http://localhost/-/liveness`
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2018-07-27 15:19:51 -04:00
|
|
|
The first endpoint, `/-/health/`, only checks whether the application server is running. It does
|
2018-07-30 17:16:27 -04:00
|
|
|
-not verify the database or other services are running. A successful response will return
|
2018-07-27 15:19:51 -04:00
|
|
|
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.
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
Readiness example output:
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
```
|
|
|
|
{
|
|
|
|
"queues_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"redis_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"shared_state_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"db_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"cache_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
Liveness example output:
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
```
|
|
|
|
{
|
|
|
|
"cache_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"db_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"redis_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"queues_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
},
|
|
|
|
"shared_state_check" : {
|
|
|
|
"status" : "ok"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
2017-04-25 05:19:43 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
## Status
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
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.
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
## Access token (Deprecated)
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
>**Note:**
|
|
|
|
Access token has been deprecated in GitLab 9.4
|
|
|
|
in favor of [IP whitelist](#ip-whitelist)
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
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.
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
![access token](img/health_check_token.png)
|
2016-09-25 06:16:14 -04:00
|
|
|
|
2017-07-11 10:30:20 -04:00
|
|
|
The access token can be passed as a URL parameter:
|
2016-09-25 06:16:14 -04:00
|
|
|
|
|
|
|
```
|
2017-07-11 10:30:20 -04:00
|
|
|
https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN
|
2016-09-25 06:16:14 -04:00
|
|
|
```
|
|
|
|
|
2017-04-29 01:25:26 -04:00
|
|
|
[ce-10416]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10416
|
2016-09-25 06:16:14 -04:00
|
|
|
[ce-3888]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3888
|
|
|
|
[pingdom]: https://www.pingdom.com
|
|
|
|
[nagios-health]: https://nagios-plugins.org/doc/man/check_http.html
|
|
|
|
[newrelic-health]: https://docs.newrelic.com/docs/alerts/alert-policies/downtime-alerts/availability-monitoring
|
2017-04-25 05:19:43 -04:00
|
|
|
[kubernetes]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
|
2017-07-11 10:53:28 -04:00
|
|
|
[admin]: ../../../administration/monitoring/ip_whitelist.md
|