diff options
| author | caleb <caleblwilliamson@gmail.com> | 2019-03-03 20:06:35 -0600 |
|---|---|---|
| committer | caleb <caleblwilliamson@gmail.com> | 2019-03-03 20:06:41 -0600 |
| commit | e915d962f0217895c7eeb5e4cdf31398dfd15d2a (patch) | |
| tree | 7896546b8ad7f0604b52dc68c11e866358694e4a /doc/user/admin_area/monitoring/health_check.md | |
| parent | c44c83c447377f974e1d3f9b7719cd115791fbb1 (diff) | |
| download | gitlab-ce-e915d962f0217895c7eeb5e4cdf31398dfd15d2a.tar.gz | |
updated health check typo
Removed the `/-/health/` typo (results in 404) and adjusted some
formatting.
Diffstat (limited to 'doc/user/admin_area/monitoring/health_check.md')
| -rw-r--r-- | doc/user/admin_area/monitoring/health_check.md | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index c22982ac190..8d5113ac469 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -16,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 format: - `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 @@ -38,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" @@ -60,9 +58,9 @@ Readiness example output: } ``` -Liveness example output: +`Liveness` probe example output: -``` +```json { "cache_check" : { "status" : "ok" |