diff options
| author | Robert Speicher <robert@gitlab.com> | 2018-07-30 23:05:06 +0300 |
|---|---|---|
| committer | Robert Speicher <robert@gitlab.com> | 2018-07-30 23:05:06 +0300 |
| commit | 1adfb156e85c270470fb10792cead9ff31b6687c (patch) | |
| tree | 05fb3cee1eb9ab9f0b62c166379ae5942e087ba1 /doc/user/admin_area/monitoring | |
| parent | 934f1f69022ab39b62161d26c4d1d485bd66b09f (diff) | |
| parent | 22d44ae9a699c418aba442cd99eec8f58d5fa006 (diff) | |
Merge branch 'sh-simplify-liveness-check' into 'master'
Add /-/health basic health check endpoint
See merge request gitlab-org/gitlab-ce!20456
Diffstat (limited to 'doc/user/admin_area/monitoring')
| -rw-r--r-- | doc/user/admin_area/monitoring/health_check.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index 20d3f2d96f4..31fcb09edcd 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` -which will then 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: |