From e915d962f0217895c7eeb5e4cdf31398dfd15d2a Mon Sep 17 00:00:00 2001 From: caleb Date: Sun, 3 Mar 2019 20:06:35 -0600 Subject: [PATCH 1/2] updated health check typo Removed the `/-/health/` typo (results in 404) and adjusted some formatting. --- doc/user/admin_area/monitoring/health_check.md | 16 +++++++--------- 1 file 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" From c4349575aaa5899c32497595ef25337716a2ce6b Mon Sep 17 00:00:00 2001 From: caleb Date: Mon, 4 Mar 2019 09:13:06 -0600 Subject: [PATCH 2/2] adjusted per Evan R suggestions in open MR Adjusted a few different areas per Evan R's suggestions within the open MR for this branch. --- doc/user/admin_area/monitoring/health_check.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index 8d5113ac469..a0c51739814 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -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 will > be deprecated in GitLab 9.1. Read more in the [old behavior](#old-behavior) @@ -22,7 +23,7 @@ To access monitoring resources, the requesting client IP needs to be included in ## Using the endpoints -With default whitelist settings, the probes can be accessed from localhost using the following format: +With default whitelist settings, the probes can be accessed from localhost using the following URLs: - `http://localhost/-/health` - `http://localhost/-/readiness` @@ -36,7 +37,7 @@ GitLab OK The readiness and liveness probes will provide a report of system health in JSON format. -`Readiness` probe example output: +`readiness` probe example output: ```json { @@ -58,7 +59,7 @@ The readiness and liveness probes will provide a report of system health in JSON } ``` -`Liveness` probe example output: +`liveness` probe example output: ```json {