Skip to content

Document health checks for testing readiness to serve clients #2264

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
merged 2 commits into from
May 9, 2025
Merged

Document health checks for testing readiness to serve clients #2264

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
967fc43
Document 'below-node-connection-limit' API health check
the-mikedavis May 9, 2025
9478a90
Document 'ready-to-serve-clients' API health check
the-mikedavis May 9, 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
19 changes: 19 additions & 0 deletions docs/http-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1702,6 +1702,25 @@ serve clients, otherwise responds with a 503 Service Unavailable. If the
target node is being drained for maintenance then this check returns 503
Service Unavailable.

### GET /api/health/checks/below-node-connection-limit

Responds a 200 OK if the target node has fewer connections to the AMQP
and AMQPS ports than the configured maximum, otherwise responds with a
503 Service Unavailable.

### GET /api/health/checks/ready-to-serve-clients

Responds a 200 OK if the target node is ready to serve clients, otherwise
responds with a 503 Service Unavailable. This check combines:

* `/api/health/checks/is-in-service`
* `/api/health/checks/protocol-listener/amqp` or `/api/health/checks/protocol-listener/amqps`
* `/api/health/checks/below-node-connection-limit`

So this check will only return 200 OK if the target node is in service,
an AMQP or AMQPS listener is available and the target node has fewer active
AMQP and AMQPS connections that its configured limit.

### GET /api/rebalance/queues

Rebalances all queues in all vhosts.
Expand Down