Skip to content

Commit 5ebd9db

Browse files
authored
Merge pull request #96 from vernemq/update-healthcheck
Update healthcheck
2 parents 442cdfb + 24b3585 commit 5ebd9db

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

monitoring/health-check.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,10 @@ description: The VerneMQ health checker
77
A simple way to gauge the health of a VerneMQ cluster is to query the `/health` path on the [HTTP listener](../configuration/http-listeners.md).
88

99
The health check will return **200** when VerneMQ is accepting connections and is joined with the cluster \(for clustered setups\). **503** will be returned in case any of those two conditions are not met.
10+
In addition to the simple `/health` path, the following options are available as well
1011

12+
- `/health/ping`: Cowboy (ie. Verne) is up.
13+
- `/health/listeners`: will fail if any of the configured listeners is down or suspended
14+
- `/health/listeners_full_cluster`: will fail if any listener is down or any of the cluster nodes is offline. (you probably don't want to use this to base automated actions on the status)
15+
16+
With the `ping` or `listeners` option, you can configure a health check for a single node, even if it is part of a cluster.

0 commit comments

Comments
 (0)