rabbitmq-diagnostics - RabbitMQ diagnostics, monitoring and health checks tools
RABBITMQ-DIAGNOSTICS(8) System Manager’s Manual RABBITMQ-DIAGNOSTICS(8)
NAME
rabbitmq-diagnostics — RabbitMQ diagnostics, monitoring and health checks tools
SYNOPSIS
rabbitmq-diagnostics [−q] [−s] [−l] [−n node] [−t timeout] command [command_options]
DESCRIPTION
rabbitmq-diagnostics is a command line tool that provides commands used for diagnostics, monitoring and health checks of RabbitMQ nodes. See the RabbitMQ documentation guides: https://www.rabbitmq.com/docs to learn more about RabbitMQ diagnostics, monitoring and health checks.
rabbitmq-diagnostics allows the operator to inspect node and cluster state. A number of health checks are available to be used interactively and by monitoring tools.
By default if it is not possible to connect to and authenticate with the target node (for example if it is stopped), the operation will fail. To learn more, see the RabbitMQ Monitoring guide: https://www.rabbitmq.com/docs/monitoring
OPTIONS
−n node
Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node.
−q, −-quiet
Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.
−s, −-silent
Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.
−t timeout, −-timeout timeout
Operation timeout in seconds. Not all commands support timeouts. Default is infinity.
−l, −-longnames
Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide: https://www.rabbitmq.com/docs/clustering
−-erlang-cookie cookie
Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide: https://www.rabbitmq.com/docs/cli
COMMANDS
Most commands provided by rabbitmq-diagnostics inspect node and cluster state or perform health checks.
Commands that list topology entities (e.g. queues) use tab as column delimiter. These commands and their arguments are delegated to rabbitmqctl(8).
Some commands ( list_queues, list_exchanges, list_bindings and list_consumers) accept an optional vhost parameter.
The list_queues, list_exchanges and list_bindings commands accept an optional virtual host parameter for which to display results. The default value is "/".
Help
help [
−l] [command_name]
Prints usage for all available commands.
−l, −-list-commands
List command usages only, without parameter explanation.
command_name
Prints usage for the specified command.
version
Displays CLI tools version
Nodes
wait
See wait in rabbitmqctl(8)
Cluster
cluster_status
See cluster_status in rabbitmqctl(8)
Users
list_users
See list_users in rabbitmqctl(8)
Access Control
list_permissions [−p vhost]
See list_permissions in rabbitmqctl(8)
list_topic_permissions [−p vhost]
See list_topic_permissions in rabbitmqctl(8)
list_user_permissions username
See list_user_permissions in rabbitmqctl(8)
list_user_topic_permissions username
See list_user_topic_permissions in rabbitmqctl(8)
list_vhosts [vhostinfoitem ...]
See list_vhosts in rabbitmqctl(8)
Monitoring, observability and health checks
alarms
Lists resource alarms, if any, in the cluster.
See RabbitMQ Resource Alarms guide: https://www.rabbitmq.com/docs/alarms to learn more.
Example:
rabbitmq-diagnostics alarms
certificates
Displays the node certificates for every listener on target node that is configured to use TLS.
Example:
rabbitmq-diagnostics certificates
check_alarms
Health check that fails (returns with a non-zero code) if there are alarms in effect on any of the cluster nodes.
See RabbitMQ Resource Alarms guide: https://www.rabbitmq.com/docs/alarms to learn more.
Example:
rabbitmq-diagnostics check_alarms
check_certificate_expiration
[
−-unit time_unit] [−-within
seconds]
Checks the expiration date on the certificates for every listener on target node that is configured to use TLS. Supported time units are:
•
days
•
weeks
•
months
•
years
Example:
rabbitmq-diagnostics check_certificate_expiration --unit weeks --within 6
check_local_alarms
Health check that fails (returns with a non-zero code) if there are alarms in effect on the target node.
See RabbitMQ Resource Alarms guide: https://www.rabbitmq.com/docs/alarms to learn more.
Example:
rabbitmq-diagnostics check_local_alarms
check_port_connectivity
Health check that fails (returns with a non-zero code) if any listener ports on the target node cannot accept a new TCP connection opened by rabbitmq-diagnostics
The check only validates if a new TCP connection is accepted. It does not perform messaging protocol handshake or authenticate.
See RabbitMQ Networking guide: https://www.rabbitmq.com/docs/networking to learn more.
Example:
rabbitmq-diagnostics check_port_connectivity
check_port_listener port
Health check that fails (returns with a non-zero code) if the target node is not listening on the specified port (there is no listener that uses that port).
See RabbitMQ Networking guide: https://www.rabbitmq.com/docs/networking to learn more.
Example:
rabbitmq-diagnostics check_port_listener 5672
check_protocol_listener protocol
Health check that fails (returns with a non-zero code) if the target node does not have a listener for the specified protocol.
See RabbitMQ Networking guide: https://www.rabbitmq.com/docs/networking to learn more.
Example:
rabbitmq-diagnostics check_protocol_listener mqtt
check_running
Health check that fails (returns with a non-zero code) if the RabbitMQ application is not running on the target node.
If rabbitmqctl(8) was used to stop the application, this check will fail.
Example:
rabbitmq-diagnostics check_running
check_virtual_hosts
Health check that checks if all vhosts are running in the target node
Example:
rabbitmq-diagnostics check_virtual_hosts --timeout 60
cipher_suites
Lists cipher suites enabled by default. To list all available cipher suites, add the --all argument.
Example:
rabbitmq-diagnostics cipher_suites --format openssl --all
command_line_arguments
Displays target node’s command-line arguments and flags as reported by the runtime.
Example:
rabbitmq-diagnostics command_line_arguments -n rabbit@hostname
consume_event_stream [
−-duration seconds | −d
seconds] [
−-pattern pattern] [−-timeout
milliseconds]
Streams internal events from a running node. Output is jq-compatible.
Example:
rabbitmq-diagnostics consume_event_stream -n rabbit@hostname --duration 20 --pattern queue_.*
discover_peers
Runs a peer discovery on the target node and prints the discovered nodes, if any.
See RabbitMQ Cluster Formation guide: https://www.rabbitmq.com/docs/cluster-formation to learn more.
Example:
rabbitmq-diagnostics discover_peers --timeout 60
environment
See environment in rabbitmqctl(8)
erlang_cookie_hash
Outputs a hashed value of the shared secret used by the target node to authenticate CLI tools and peers. The value can be compared with the hash found in error messages of CLI tools.
See RabbitMQ Clustering guide: https://www.rabbitmq.com/docs/clustering#erlang-cookie to learn more.
Example:
rabbitmq-diagnostics erlang_cookie_hash -q
erlang_version
Reports target node’s Erlang/OTP version.
Example:
rabbitmq-diagnostics erlang_version -q
is_booting
Reports if RabbitMQ application is currently booting (not booted/running or stopped) on the target node.
Example:
rabbitmq-diagnostics is_booting
is_running
Reports if RabbitMQ application is fully booted and running (that is, not stopped) on the target node.
Example:
rabbitmq-diagnostics is_running
list_bindings [
−p vhost] [bindinginfoitem ...]
See list_bindings in rabbitmqctl(8)
list_channels [channelinfoitem ...]
See list_channels in rabbitmqctl(8)
list_ciphers
See list_ciphers in rabbitmqctl(8)
list_connections [connectioninfoitem ...]
See list_connections in rabbitmqctl(8)
list_consumers [−p vhost]
See list_consumers in rabbitmqctl(8)
list_exchanges [
−p vhost] [exchangeinfoitem ...]
See list_exchanges in rabbitmqctl(8)
list_hashes
See list_hashes in rabbitmqctl(8)
list_queues [
−p vhost] [
−-offline | −-online |
−-local] [queueinfoitem ...]
See
list_queues in rabbitmqctl(8)
] [
−-local ] [
−-queue-timeout milliseconds ] [
column ... ] [−-no-table-headers]
list_unresponsive_queues
See list_unresponsive_queues in rabbitmqctl(8)
listeners
Lists listeners (bound sockets) on this node. Use this to inspect what protocols and ports the node is listening on for client, CLI tool and peer connections.
See RabbitMQ Networking guide: https://www.rabbitmq.com/docs/networking to learn more.
Example:
rabbitmq-diagnostics listeners