rabbitmq-diagnostics
—
rabbitmq-diagnostics |
[-q -s -l -n
node-t
timeoutcommand_options ] |
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 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
-n
nodeRABBITMQ_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
-s
,
--silent
-t
timeout,
--timeout
timeoutinfinity
.-l
,
--longnames
--erlang-cookie
cookieRABBITMQ_ERLANG_COOKIE
environment
variable instead of specifying this option on the command line. To learn
more, see the
RabbitMQ CLI
Tools guiderabbitmq-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
[-l
-l
,
--list-commands
version
wait
wait
in
rabbitmqctl(8)cluster_status
cluster_status
in
rabbitmqctl(8)list_users
list_users
in
rabbitmqctl(8)list_permissions
[-p
vhostlist_permissions
in
rabbitmqctl(8)list_topic_permissions
[-p
vhostlist_topic_permissions
in
rabbitmqctl(8)list_user_permissions
usernamelist_user_permissions
in
rabbitmqctl(8)list_user_topic_permissions
usernamelist_user_topic_permissions
in
rabbitmqctl(8)list_vhosts
[list_vhosts
in
rabbitmqctl(8)alarms
rabbitmq-diagnostics
alarms
certificates
rabbitmq-diagnostics
certificates
check_alarms
rabbitmq-diagnostics
check_alarms
check_certificate_expiration
[--unit
time_unit--within
secondsrabbitmq-diagnostics
check_certificate_expiration --unit weeks --within 6
check_local_alarms
rabbitmq-diagnostics
check_local_alarms
check_port_connectivity
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 to learn more.
Example:
rabbitmq-diagnostics
check_port_connectivity
check_port_listener
portrabbitmq-diagnostics
check_port_listener 5672
check_protocol_listener
protocolrabbitmq-diagnostics
check_protocol_listener mqtt
check_running
rabbitmqctl(8)
was used to stop the
application, this check will fail.
Example:
rabbitmq-diagnostics
check_running
check_virtual_hosts
rabbitmq-diagnostics
check_virtual_hosts --timeout 60
cipher_suites
rabbitmq-diagnostics
cipher_suites --format openssl --all
command_line_arguments
rabbitmq-diagnostics
command_line_arguments -n rabbit@hostname
consume_event_stream
[--duration
seconds |
-d
seconds--pattern
pattern--timeout
millisecondsrabbitmq-diagnostics
consume_event_stream -n rabbit@hostname --duration 20 --pattern
queue_.*
discover_peers
rabbitmq-diagnostics
discover_peers --timeout 60
environment
environment
in
rabbitmqctl(8)erlang_cookie_hash
rabbitmq-diagnostics
erlang_cookie_hash -q
erlang_version
rabbitmq-diagnostics
erlang_version -q
is_booting
rabbitmq-diagnostics
is_booting
is_running
rabbitmq-diagnostics
is_running
list_bindings
[-p
vhostlist_bindings
in
rabbitmqctl(8)list_channels
[list_channels
in
rabbitmqctl(8)list_ciphers
list_ciphers
in
rabbitmqctl(8)list_connections
[list_connections
in
rabbitmqctl(8)list_consumers
[-p
vhostlist_consumers
in
rabbitmqctl(8)list_exchanges
[-p
vhostlist_exchanges
in
rabbitmqctl(8)list_hashes
list_hashes
in
rabbitmqctl(8)list_queues
[-p
vhost--offline
|
--online
|
--local
list_queues
in
rabbitmqctl(8)list_unresponsive_queues
[--local
--queue-timeout
milliseconds--no-table-headers
list_unresponsive_queues
in
rabbitmqctl(8)listeners
rabbitmq-diagnostics
listeners
log_tail
[--number
number |
-N
number
[--timeout
millisecondsrabbitmq-diagnostics log_tail
--number 100
log_tail_stream
[--duration
seconds |
-d
seconds--timeout
millisecondsrabbitmq-diagnostics
log_tail_stream --duration 60
maybe_stuck
rabbitmq-diagnostics maybe_stuck
-q
memory_breakdown
[--unit
memory_unitrabbitmq-diagnostics
memory_breakdown --unit gigabytes
observer
[--interval
secondsrabbitmq-diagnostics observer
--interval 10
ping
rabbitmq-diagnostics
can authenticate
with it successfully.report
report
in
rabbitmqctl(8)runtime_thread_stats
[--sample-interval
intervalrabbitmq-diagnostics
runtime_thread_stats --sample-interval 15
schema_info
[--no_table_headers
--timeout
millisecondsschema_info
in
rabbitmqctl(8)server_version
rabbitmq-diagnostics
server_version -q
status
status
in
rabbitmqctl(8)tls_versions
rabbitmq-diagnostics tls_versions
-q
list_global_parameters
list_global_parameters
in
rabbitmqctl(8)list_parameters
[-p
vhostlist_parameters
in
rabbitmqctl(8)list_operator_policies
[-p
vhostlist_operator_policies
in
rabbitmqctl(8)list_policies
[-p
vhostlist_policies
in
rabbitmqctl(8)list_vhost_limits
[--vhost
vhost--global
--no-table-headers
list_vhost_limits
in
rabbitmqctl(8)log_location
[--all
|
-a
--timeout
millisecondsrabbitmq-diagnostics log_location
-a
list_feature_flags
[--timeout
millisecondslist_feature_flags
in
rabbitmqctl(8)quorum_status
queue
[--vhost
vhostquorum_status
in
rabbitmq-queues(8)check_if_node_is_mirror_sync_critical
check_if_node_is_mirror_sync_critical
in
rabbitmq-queues(8)check_if_node_is_quorum_critical
check_if_node_is_quorum_critical
in
rabbitmq-queues(8)