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

Merge branch 'docs-update-health-check' into 'master'

Browse source 
Update Health Check typo & adjust formatting

See merge request gitlab-org/gitlab-ce!25722
This commit is contained in:
Evan Read 2019-03-05 06:19:37 +00:00
commit fdcfae2a92
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/user/admin_area/monitoring/health_check.md
View file

@ -1,6 +1,7 @@
# Health Check
> **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 was
> be deprecated in GitLab 9.1.
@ -15,21 +16,19 @@ traffic until the system is ready or restart the container as needed.
## IP whitelist
To access monitoring resources, the client IP needs to be included in a whitelist.
To access monitoring resources, the requesting client IP needs to be included in a whitelist.
[Read how to add IPs to a whitelist for the monitoring endpoints][admin].
## Using the endpoints
With default whitelist settings, the probes can be accessed from localhost:
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:
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
@ -37,9 +36,9 @@ GitLab OK
The readiness and liveness probes will provide a report of system health in JSON format.
Readiness example output:
`readiness` probe example output:
```
```json
{
"queues_check" : {
"status" : "ok"
@ -59,9 +58,9 @@ Readiness example output:
}
```
Liveness example output:
`liveness` probe example output:
```
```json
{
"cache_check" : {
"status" : "ok"