diff --git a/monitoring/health-check.md b/monitoring/health-check.md index 5696600..68bb211 100644 --- a/monitoring/health-check.md +++ b/monitoring/health-check.md @@ -7,4 +7,10 @@ description: The VerneMQ health checker 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). 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. +In addition to the simple `/health` path, the following options are available as well +- `/health/ping`: Cowboy (ie. Verne) is up. +- `/health/listeners`: will fail if any of the configured listeners is down or suspended +- `/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) + +With the `ping` or `listeners` option, you can configure a health check for a single node, even if it is part of a cluster.