Skip to content

Update healthcheck #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ioolkos merged 2 commits into from
May 2, 2025
Merged

Update healthcheck #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17e4245
Update health-check.md with additional path options
ioolkos Mar 18, 2025
24b3585
Format options
ioolkos Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions monitoring/health-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.