diff options
Diffstat (limited to 'doc/user/admin_area/monitoring/health_check.md')
| -rw-r--r-- | doc/user/admin_area/monitoring/health_check.md | 26 |
1 files changed, 10 insertions, 16 deletions
diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index f69584fcb94..91e29118e3e 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -4,8 +4,8 @@ type: concepts, howto # Health Check **(CORE ONLY)** -> - 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 was +> - Liveness and readiness probes were [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10416) in GitLab 9.1. +> - The `health_check` endpoint was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3888) in GitLab 8.8 and was > deprecated in GitLab 9.1. > - [Access token](#access-token-deprecated) has been deprecated in GitLab 9.4 > in favor of [IP whitelist](#ip-whitelist). @@ -25,15 +25,15 @@ For details, see [how to add IPs to a whitelist for the monitoring endpoints](.. With default whitelist settings, the probes can be accessed from localhost using the following URLs: -```text +```plaintext GET http://localhost/-/health ``` -```text +```plaintext GET http://localhost/-/readiness ``` -```text +```plaintext GET http://localhost/-/liveness ``` @@ -45,7 +45,7 @@ are running. This endpoint circumvents Rails Controllers and is implemented as additional middleware `BasicHealthCheck` very early into the request processing lifecycle. -```text +```plaintext GET /-/health ``` @@ -57,7 +57,7 @@ curl 'https://gitlab.example.com/-/health' Example response: -```text +```plaintext GitLab OK ``` @@ -71,7 +71,7 @@ If the `all=1` parameter is specified, the check will also validate the dependent services (Database, Redis, Gitaly etc.) and gives a status for each. -```text +```plaintext GET /-/readiness GET /-/readiness?all=1 ``` @@ -111,7 +111,7 @@ Checks whether the application server is running. This probe is used to know if Rails Controllers are not deadlocked due to a multi-threading. -```text +```plaintext GET /-/liveness ``` @@ -148,7 +148,7 @@ accepted token can be found under the **Admin Area > Monitoring > Health check** The access token can be passed as a URL parameter: -```text +```plaintext https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN ``` @@ -163,9 +163,3 @@ 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. --> - -[ce-10416]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10416 -[ce-3888]: https://gitlab.com/gitlab-org/gitlab-foss/-/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 |