Health check

Health checks for monitoring RabbitMQ nodes and cluster status.

alarms() -> dict async

Check for any active resource alarms in the cluster.

Returns:

Type	Description
dict	{"status": "ok"} or a failure dict with alarm details.

certificate_expiration(within: int, unit: TimeUnit) -> dict async

Check for TLS certificates expiring within a given timeframe.

Parameters:

Name	Type	Description	Default
within	int	Number of time units.	required
unit	TimeUnit	Time unit (days, weeks, months, years).	required

has_critical_mirror_sync() -> dict async

Check for classic mirrored queues at risk of data loss if node shuts down.

local_alarms() -> dict async

Check for active resource alarms on the target node.

Returns:

Type	Description
dict	{"status": "ok"} or a failure dict with alarm details.

node_quorum_critical() -> dict async

Check for quorum queues at risk of losing availability if node shuts down.

port_listener(port: int) -> dict async

Check if a specific port is actively listening.

protocol_listener(protocol: ProtocolUnit) -> dict async

Check if an active listener exists for a specific protocol.

Parameters:

Name	Type	Description	Default
protocol	ProtocolUnit	amqp091, amqp10, mqtt, stomp, web-mqtt, or web-stomp.	required

vhosts() -> dict async

Check if all virtual hosts are running on the target node.