debian-mirror-gitlab/doc/user/admin_area/monitoring/health_check.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

149 lines
3.8 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2021-12-11 22:18:48 +05:30
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2019-09-04 21:01:54 +05:30
---
2016-11-03 12:29:30 +05:30
2021-03-11 19:13:27 +05:30
# Health Check **(FREE SELF)**
2019-07-07 11:18:12 +05:30
2017-08-17 22:00:37 +05:30
GitLab provides liveness and readiness probes to indicate service health and
reachability to required services. These probes report on the status of the
2021-03-11 19:13:27 +05:30
database connection, Redis connection, and access to the file system. These
2019-12-26 22:10:19 +05:30
endpoints [can be provided to schedulers like Kubernetes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) to hold
2017-08-17 22:00:37 +05:30
traffic until the system is ready or restart the container as needed.
2016-11-03 12:29:30 +05:30
2022-07-23 23:45:48 +05:30
## IP allowlist
2016-11-03 12:29:30 +05:30
2022-07-23 23:45:48 +05:30
To access monitoring resources, the requesting client IP needs to be included in the allowlist.
2022-11-25 23:54:43 +05:30
For details, see [how to add IPs to the allowlist for the monitoring endpoints](../../../administration/monitoring/ip_allowlist.md).
2016-11-03 12:29:30 +05:30
2019-12-04 20:38:33 +05:30
## Using the endpoints locally
2016-11-03 12:29:30 +05:30
2022-07-23 23:45:48 +05:30
With default allowlist settings, the probes can be accessed from localhost using the following URLs:
2017-09-10 17:25:29 +05:30
2020-05-24 23:13:21 +05:30
```plaintext
2019-12-04 20:38:33 +05:30
GET http://localhost/-/health
```
2020-05-24 23:13:21 +05:30
```plaintext
2019-12-04 20:38:33 +05:30
GET http://localhost/-/readiness
```
2020-05-24 23:13:21 +05:30
```plaintext
2019-12-04 20:38:33 +05:30
GET http://localhost/-/liveness
```
## Health
2016-11-03 12:29:30 +05:30
2019-12-26 22:10:19 +05:30
Checks whether the application server is running.
It does not verify the database or other services
are running. This endpoint circumvents Rails Controllers
and is implemented as additional middleware `BasicHealthCheck`
very early into the request processing lifecycle.
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
```plaintext
2019-12-04 20:38:33 +05:30
GET /-/health
```
Example request:
2020-03-13 15:44:24 +05:30
```shell
2021-02-22 17:27:13 +05:30
curl "https://gitlab.example.com/-/health"
2019-12-04 20:38:33 +05:30
```
Example response:
2018-11-18 11:00:15 +05:30
2020-05-24 23:13:21 +05:30
```plaintext
2018-11-18 11:00:15 +05:30
GitLab OK
```
2019-12-04 20:38:33 +05:30
## Readiness
2019-12-26 22:10:19 +05:30
The readiness probe checks whether the GitLab instance is ready
to accept traffic via Rails Controllers. The check by default
does validate only instance-checks.
2021-02-22 17:27:13 +05:30
If the `all=1` parameter is specified, the check also validates
2019-12-26 22:10:19 +05:30
the dependent services (Database, Redis, Gitaly etc.)
and gives a status for each.
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
```plaintext
2019-12-04 20:38:33 +05:30
GET /-/readiness
2019-12-26 22:10:19 +05:30
GET /-/readiness?all=1
2019-12-04 20:38:33 +05:30
```
Example request:
2017-09-10 17:25:29 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-02-22 17:27:13 +05:30
curl "https://gitlab.example.com/-/readiness"
2019-12-04 20:38:33 +05:30
```
Example response:
2016-11-03 12:29:30 +05:30
2019-07-07 11:18:12 +05:30
```json
2017-08-17 22:00:37 +05:30
{
2019-12-26 22:10:19 +05:30
"master_check":[{
2019-12-04 20:38:33 +05:30
"status":"failed",
2019-12-26 22:10:19 +05:30
"message": "unexpected Master check result: false"
}],
...
}
2016-11-03 12:29:30 +05:30
```
2021-02-22 17:27:13 +05:30
On failure, the endpoint returns a `503` HTTP status code.
2019-12-26 22:10:19 +05:30
This check does hit the database and Redis if authenticated via `token`.
This check is being exempt from Rack Attack.
2019-12-04 20:38:33 +05:30
## Liveness
2021-02-22 17:27:13 +05:30
WARNING:
2020-01-01 13:55:28 +05:30
In GitLab [12.4](https://about.gitlab.com/upcoming-releases/)
2019-12-26 22:10:19 +05:30
the response body of the Liveness check was changed
to match the example below.
2019-12-21 20:55:43 +05:30
2019-12-26 22:10:19 +05:30
Checks whether the application server is running.
This probe is used to know if Rails Controllers
are not deadlocked due to a multi-threading.
2019-12-04 20:38:33 +05:30
2020-05-24 23:13:21 +05:30
```plaintext
2019-12-04 20:38:33 +05:30
GET /-/liveness
```
Example request:
2020-03-13 15:44:24 +05:30
```shell
2021-02-22 17:27:13 +05:30
curl "https://gitlab.example.com/-/liveness"
2019-12-04 20:38:33 +05:30
```
Example response:
2021-02-22 17:27:13 +05:30
On success, the endpoint returns a `200` HTTP status code, and a response like below.
2017-08-17 22:00:37 +05:30
2019-07-07 11:18:12 +05:30
```json
2017-09-10 17:25:29 +05:30
{
2019-12-21 20:55:43 +05:30
"status": "ok"
2017-09-10 17:25:29 +05:30
}
```
2017-08-17 22:00:37 +05:30
2021-02-22 17:27:13 +05:30
On failure, the endpoint returns a `503` HTTP status code.
2019-12-26 22:10:19 +05:30
This check is being exempt from Rack Attack.
2017-08-17 22:00:37 +05:30
2022-03-02 08:16:31 +05:30
## Sidekiq
2016-11-03 12:29:30 +05:30
2022-03-02 08:16:31 +05:30
Learn how to configure the [Sidekiq health checks](../../../administration/sidekiq_health_check.md).
2020-07-28 23:09:34 +05:30
2019-09-04 21:01:54 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->