diff options
author | Stan Hu <stanhu@gmail.com> | 2018-07-06 23:20:02 +0300 |
---|---|---|
committer | Stan Hu <stanhu@gmail.com> | 2018-07-29 00:35:02 +0300 |
commit | eb2bc7d99a99981150f32ac2469bff29eebbfa19 (patch) | |
tree | 89fa9dab380931b67718443ab17f61c486df12c9 /doc | |
parent | 87f03f01735fb4b6dbef2e4bf625cf2546523a4e (diff) |
Simplify /-/liveness check to avoid connecting to the database
The previous implementation would hit the database each time
and provide a dummy response. If the database goes down, this
means all application workers would be taken out of service.
Simplify this check by using a Rails middleware that intercepts
this endpoint and returns a 200 response.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/user/admin_area/monitoring/health_check.md | 27 |
1 files changed, 5 insertions, 22 deletions
diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index 843fb4ce26b..958962fbfbc 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -27,7 +27,7 @@ With default whitelist settings, the probes can be accessed from localhost: - `http://localhost/-/readiness` - `http://localhost/-/liveness` -which will then provide a report of system health in JSON format. +The readiness endpoint will provide a report of system health in JSON format. Readiness example output: @@ -57,29 +57,12 @@ Readiness example output: } ``` -Liveness 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: ``` -{ - "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" - } -} +GitLab is alive ``` ## Status |