diff options
author | Stan Hu <stanhu@gmail.com> | 2018-07-27 22:19:51 +0300 |
---|---|---|
committer | Stan Hu <stanhu@gmail.com> | 2018-07-29 00:35:02 +0300 |
commit | 22d44ae9a699c418aba442cd99eec8f58d5fa006 (patch) | |
tree | 035cd854d43f390b3684e123be74482485e25296 /doc/user/admin_area/monitoring | |
parent | eb2bc7d99a99981150f32ac2469bff29eebbfa19 (diff) |
Use /-/health instead of breaking /-/liveness
Diffstat (limited to 'doc/user/admin_area/monitoring')
-rw-r--r-- | doc/user/admin_area/monitoring/health_check.md | 39 |
1 files changed, 33 insertions, 6 deletions
diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index 958962fbfbc..6cbca6bd1db 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -20,14 +20,24 @@ To access monitoring resources, the client IP needs to be included in a whitelis [Read how to add IPs to a whitelist for the monitoring endpoints][admin]. -## Using the endpoint +## Using the endpoints With default whitelist settings, the probes can be accessed from localhost: +- `http://localhost/-/health` - `http://localhost/-/readiness` - `http://localhost/-/liveness` -The readiness endpoint will provide a report of system health in JSON format. + +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 with return +a 200 status code with the following message: + +``` +GitLab OK +``` + +The readiness and liveness probes will provide a report of system health in JSON format. Readiness example output: @@ -57,12 +67,29 @@ Readiness example output: } ``` -The liveness endpoint only checks whether the application server is running. It does -not verify the database or other services are running. A successful response with return -a 200 status code with the following message: +Liveness example output: ``` -GitLab is alive +{ + "fs_shards_check" : { + "status" : "ok" + }, + "cache_check" : { + "status" : "ok" + }, + "db_check" : { + "status" : "ok" + }, + "redis_check" : { + "status" : "ok" + }, + "queues_check" : { + "status" : "ok" + }, + "shared_state_check" : { + "status" : "ok" + } +} ``` ## Status |