kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'docs/fix-note-list' into 'master' 

Fix formatting of health check info

See merge request gitlab-org/gitlab-ce!28761
This commit is contained in:
Achilleas Pipinellis 2019-05-27 15:55:20 +00:00
parent 71985c064e b6ceb5aa4d
commit 14e73771df
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/user/admin_area/monitoring/health_check.md
View File

@ -4,13 +4,11 @@ type: concepts, howto
# Health Check # Health Check
> NOTE: **Note:** > - 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][ce-10416] in GitLab 9.1. > be deprecated in GitLab 9.1.
> - The `health_check` endpoint was [introduced][ce-3888] in GitLab 8.8 and was > - [Access token](#access-token-deprecated) has been deprecated in GitLab 9.4
> be deprecated in GitLab 9.1. > in favor of [IP whitelist](#ip-whitelist).
> - [Access token](#access-token-deprecated) has been deprecated in GitLab 9.4
> in favor of [IP whitelist](#ip-whitelist).
GitLab provides liveness and readiness probes to indicate service health and GitLab provides liveness and readiness probes to indicate service health and
reachability to required services. These probes report on the status of the reachability to required services. These probes report on the status of the
@ -33,7 +31,7 @@ With default whitelist settings, the probes can be accessed from localhost using
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: 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:
``` ```text
GitLab OK GitLab OK
``` ```
@ -101,7 +99,7 @@ accepted token can be found under the **Admin area ➔ Monitoring ➔ Health che
The access token can be passed as a URL parameter: The access token can be passed as a URL parameter:
``` ```text
https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN
``` ```
@ -122,4 +120,4 @@ but commented out to help encourage others to add to it in the future. -->
[pingdom]: https://www.pingdom.com [pingdom]: https://www.pingdom.com
[nagios-health]: https://nagios-plugins.org/doc/man/check_http.html [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 [newrelic-health]: https://docs.newrelic.com/docs/alerts/alert-policies/downtime-alerts/availability-monitoring
[kubernetes]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/ [kubernetes]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/