{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":28876,"path":"it-operations-management/agent-client-collector/rabbitmq-checks-policies.md","title":"RabbitMQ default checks and policies","bundle":null,"doc_type":null,"release":"australia","body":"\n# RabbitMQ default checks and policies\n\nAgent Client Collector provides the following default checks and policies for RabbitMQ health monitoring. You must perform RabbitMQ discovery before executing the checks. RabbitMQ checks are available only in a Windows environment.\n\n\n
\n\nType\n\n\n\nCheck\n\n\n\nDescription\n\n\n\nCommand\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-alive\n\n\n\nVerifies whether the RabbitMQ server is alive, using the REST API. If the server is down, an alert triggers.\n\n\n\n`check-rabbitmq-alive.rb --host {{.labels.params_host}} --port {{.labels.params_port}} -v {{.labels.params_vhost}}`\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-cluster-health\n\n\n\nVerifies whether the RabbitMQ server's cluster nodes are running. If the nodes are down, an alert triggers.\n\n\n\n`check-rabbitmq-cluster-health.rb --host {{.labels.params_host}} --port {{.labels.params_port}}`\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-consumers\n\n\n\nVerifies the number of consumers on the RabbitMQ server and triggers an alert based on the configured threshold.\n\n\n\n`check-rabbitmq-consumers.rb {{if .labels.params_warn}} --warn {{.labels.params_warn}} {{end}} {{if .labels.params_critical}} --critical {{.labels.params_critical}} {{end}} --host {{.labels.params_host}} --port {{.labels.params_port}}`\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-messages\n\n\n\nVerifies the total number of messages queued on the RabbitMQ server and triggers an alert based on the threshold.\n\n\n\n`check-rabbitmq-messages.rb --critical {{.labels.params_critical}} --port {{.labels.params_port}} --warn {{.labels.params_warn}} --host {{.labels.params_host}}`\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-network-partitions\n\n\n\nVerifies whether the RabbitMQ network partition has occurred and triggers an alert based on the threshold.\n\n\n\ncheck-rabbitmq-network-partitions.rb --host \\{\\{.labels.params\\_host\\}\\} --port \\{\\{.labels.params\\_port\\}\\}\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-node-health\n\n\n\nVerifies whether the RabbitMQ server node is in a running state.\n\n\n\n```\ncheck-rabbitmq-node-health.rb --host {{.labels.params_host}} {{if .labels.params_watchalarms}} --alarms {{.labels.params_watchalarms}} {{end}} {{if .labels.params_socketwarn}} --swarn {{.labels.params_socketwarn}} {{end}} {{if .labels.params_memcrit}} --mcrit {{.labels.params_memcrit}} {{end}} {{if .labels.params_fdcrit}} --fcrit {{.labels.params_fdcrit}} {{end}} {{if .labels.params_socketcrit}} --scrit {{.labels.params_socketcrit}} {{end}} --port {{.labels.params_port}} {{if .labels.params_memwarn}} --mwarn {{.labels.params_memwarn}} {{end}} {{if .labels.params_fdwarn}} --fwarn {{.labels.params_fdwarn}} {{end}}\n```\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-node-usage\n\n\n\nChecks and displays usage of the RabbitMQ server node.\n\n\n\n```\ncheck-rabbitmq-node-usage.rb {{if .labels.params_procwarn}} --pwarn {{.labels.params_procwarn}} {{end}} --port {{.labels.params_port}} {{if .labels.params_socketwarn}} --swarn {{.labels.params_socketwarn}} {{end}} --type {{.labels.params_type}} {{if .labels.params_diskcrit}} --dcrit {{.labels.params_diskcrit}} {{end}} {{if .labels.params_fdcrit}} --fcrit {{.labels.params_fdcrit}} {{end}} {{if .labels.params_proccrit}} --pcrit {{.labels.params_proccrit}} {{end}} {{if .labels.params_diskwarn}} --dwarn {{.labels.params_diskwarn}} {{end}} {{if .labels.params_socketcrit}} --scrit {{.labels.params_socketcrit}} {{end}} --host {{.labels.params_host}} {{if .labels.params_memcrit}} --mcrit {{.labels.params_memcrit}} {{end}} {{if .labels.params_fdwarn}} --fwarn {{.labels.params_fdwarn}} {{end}} {{if .labels.params_memwarn}} mwarn {{.labels.params_memwarn}} {{end}}\n```\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-queue-drain-time\n\n\n\nVerifies the time it will take for each queue on the RabbitMQ server to drain, based on the current message exit rate.For example, if a queue has 1,000 messages in it but only 1 message exits per second, an alert generates. The default critical level of 360 seconds has been exceeded.\n\n\n\n`check-rabbitmq-queue-drain-time.rb --host {{.labels.params_host}} --port {{.labels.params_port}} --warn {{.labels.params_warn}} --critical {{.labels.params_critical}}`\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-queues-synchronised\n\n\n\nVerifies that all mirrored queues with secondary queues are synchronised.\n\n\n\n`check-rabbitmq-queues-synchronised.rb --host {{.labels.params_host}} --port {{.labels.params_port}}`\n\n
\n\nEvent\n\n\n\ncheck-rabbitmq-stomp-alive\n\n\n\nVerifies whether the RabbitMQ server is alive and responding to STOMP.\n\n\n\n`check-rabbitmq-stomp-alive.rb --host {{.labels.params_host}} --queue {{.labels.params_queue}} --port {{.labels.params_port}}`\n\n
|Type|Check|Description|Command|\n|----|-----|-----------|-------|\n|Metric|metrics-rabbitmq-overview|Provides RabbitMQ overview statistics.|`metrics-rabbitmq-overview.rb --port {{.labels.params_port}} --host {{.labels.params_host}}`|\n|Metric|metrics-rabbitmq-queue|Provides RabbitMQ metrics per queue.|`metrics-rabbitmq-queue.rb --port {{.labels.params_port}} --host {{.labels.params_host}} {{if .labels.params_vhost}} --vhost {{.labels.params_vhost}} {{end}}`|\n\n**Parent Topic:**[Agent Client Collector Monitoring default checks and policies](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/agent-client-collector/agent-policies-checks.md)\n\n"}}