Commit e915d962 authored by caleb's avatar caleb

updated health check typo

Removed the `/-/health/` typo (results in 404) and adjusted some
formatting.
parent c44c83c4
......@@ -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"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment