1RABBITMQ-DIAGNOSTICS(8) BSD System Manager's Manual RABBITMQ-DIAGNOSTICS(8)
2
4 rabbitmq-diagnostics — RabbitMQ diagnostics, monitoring and health checks
5 tools
6
8 rabbitmq-diagnostics [-q] [-s] [-l] [-n node] [-t timeout] command
9 [command_options]
10
12 rabbitmq-diagnostics is a command line tool that provides commands used
13 for diagnostics, monitoring and health checks of RabbitMQ nodes. See the
14 RabbitMQ documentation guides: https://rabbitmq.com/documentation.html to
15 learn more about RabbitMQ diagnostics, monitoring and health checks.
16 rabbitmq-diagnostics allows the operator to inspect node and cluster
18 state. A number of health checks are available to be used interactively
19 and by monitoring tools.
20 By default if it is not possible to connect to and authenticate with the
23 target node (for example if it is stopped), the operation will fail. To
24 learn more, see the RabbitMQ Monitoring guide:
25 https://rabbitmq.com/monitoring.html
26
28 -n node
29 Default node is "rabbit@target-hostname", where target-hostname
30 is the local host. On a host named "myserver.example.com", the
31 node name will usually be "rabbit@myserver" (unless
32 RABBITMQ_NODENAME has been overridden). The output of "hostname
33 -s" is usually the correct suffix to use after the "@" sign. See
34 rabbitmq-server(8) for details of configuring a RabbitMQ node.
35 -q, --quiet
37 Quiet output mode is selected. Informational messages are re‐
38 duced when quiet mode is in effect.
39 -s, --silent
41 Silent output mode is selected. Informational messages are re‐
42 duced and table headers are suppressed when silent mode is in ef‐
43 fect.
44 -t timeout, --timeout timeout
46 Operation timeout in seconds. Not all commands support timeouts.
47 Default is infinity.
48 -l, --longnames
50 Must be specified when the cluster is configured to use long
51 (FQDN) node names. To learn more, see the RabbitMQ Clustering
52 guide: https://rabbitmq.com/clustering.html
53 --erlang-cookie cookie
55 Shared secret to use to authenticate to the target node. Prefer
56 using a local file or the RABBITMQ_ERLANG_COOKIE environment
57 variable instead of specifying this option on the command line.
58 To learn more, see the RabbitMQ CLI Tools guide:
59 https://rabbitmq.com/cli.html
60
62 Most commands provided by rabbitmq-diagnostics inspect node and cluster
63 state or perform health checks.
64 Commands that list topology entities (e.g. queues) use tab as column de‐
66 limiter. These commands and their arguments are delegated to rabbit‐
67 mqctl(8).
68 Some commands ( list_queues, list_exchanges, list_bindings and
70 list_consumers) accept an optional vhost parameter.
71 The list_queues, list_exchanges and list_bindings commands accept an op‐
73 tional virtual host parameter for which to display results. The default
74 value is "/".
75 Help
77 help [-l] [command_name]
78 Prints usage for all available commands.
80 -l, --list-commands
82 List command usages only, without parameter explanation.
83 command_name
85 Prints usage for the specified command.
86 version
88 Displays CLI tools version
90 Nodes
92 wait
93 See wait in rabbitmqctl(8)
95 Cluster
97 cluster_status
98 See cluster_status in rabbitmqctl(8)
100 Users
102 list_users
103 See list_users in rabbitmqctl(8)
105 Access Control
107 list_permissions [-p vhost]
108 See list_permissions in rabbitmqctl(8)
110 list_topic_permissions [-p vhost]
112 See list_topic_permissions in rabbitmqctl(8)
114 list_user_permissions username
116 See list_user_permissions in rabbitmqctl(8)
118 list_user_topic_permissions username
120 See list_user_topic_permissions in rabbitmqctl(8)
122 list_vhosts [vhostinfoitem ...]
124 See list_vhosts in rabbitmqctl(8)
126 Monitoring, observability and health checks
128 alarms
129 Lists resource alarms, if any, in the cluster.
131 See RabbitMQ Resource Alarms guide:
133 https://rabbitmq.com/alarms.html to learn more.
134 Example:
136 rabbitmq-diagnostics alarms
137 certificates
139 Displays the node certificates for every listener on target node
141 that is configured to use TLS.
142 Example:
144 rabbitmq-diagnostics certificates
146 check_alarms
148 Health check that fails (returns with a non-zero code) if there are
150 alarms in effect on any of the cluster nodes.
151 See RabbitMQ Resource Alarms guide:
153 https://rabbitmq.com/alarms.html to learn more.
154 Example:
156 rabbitmq-diagnostics check_alarms
157 check_certificate_expiration [--unit time_unit] [--within seconds]
159 Checks the expiration date on the certificates for every listener
161 on target node that is configured to use TLS. Supported time units
162 are:
163 • days
165 • weeks
167 • months
169 • years
171 Example:
173 rabbitmq-diagnostics check_certificate_expiration --unit
174 weeks --within 6
175 check_local_alarms
177 Health check that fails (returns with a non-zero code) if there are
179 alarms in effect on the target node.
180 See RabbitMQ Resource Alarms guide:
182 https://rabbitmq.com/alarms.html to learn more.
183 Example:
185 rabbitmq-diagnostics check_local_alarms
186 check_port_connectivity
188 Health check that fails (returns with a non-zero code) if any lis‐
190 tener ports on the target node cannot accept a new TCP connection
191 opened by rabbitmq-diagnostics
192 The check only validates if a new TCP connection is accepted. It
194 does not perform messaging protocol handshake or authenticate.
195 See RabbitMQ Networking guide: https://rabbitmq.com/networking.html
197 to learn more.
198 Example:
200 rabbitmq-diagnostics check_port_connectivity
201 check_port_listener port
203 Health check that fails (returns with a non-zero code) if the tar‐
205 get node is not listening on the specified port (there is no lis‐
206 tener that uses that port).
207 See RabbitMQ Networking guide: https://rabbitmq.com/networking.html
209 to learn more.
210 Example:
212 rabbitmq-diagnostics check_port_listener 5672
213 check_protocol_listener protocol
215 Health check that fails (returns with a non-zero code) if the tar‐
217 get node does not have a listener for the specified protocol.
218 See RabbitMQ Networking guide: https://rabbitmq.com/networking.html
220 to learn more.
221 Example:
223 rabbitmq-diagnostics check_protocol_listener mqtt
224 check_running
226 Health check that fails (returns with a non-zero code) if the Rab‐
228 bitMQ application is not running on the target node.
229 If rabbitmqctl(8) was used to stop the application, this check will
231 fail.
232 Example:
234 rabbitmq-diagnostics check_running
235 check_virtual_hosts
237 Health check that checks if all vhosts are running in the target
239 node
240 Example:
242 rabbitmq-diagnostics check_virtual_hosts --timeout 60
243 cipher_suites
245 Lists cipher suites enabled by default. To list all available ci‐
247 pher suites, add the --all argument.
248 Example:
250 rabbitmq-diagnostics cipher_suites --format openssl --all
251 command_line_arguments
253 Displays target node's command-line arguments and flags as reported
255 by the runtime.
256 Example:
258 rabbitmq-diagnostics command_line_arguments -n
259 rabbit@hostname
260 consume_event_stream [--duration seconds | -d seconds] [--pattern pattern]
262 [--timeout milliseconds]
263 Streams internal events from a running node. Output is jq-compati‐
265 ble.
266 Example:
268 rabbitmq-diagnostics consume_event_stream -n rabbit@hostname
269 --duration 20 --pattern queue_.*
270 discover_peers
272 Runs a peer discovery on the target node and prints the discovered
274 nodes, if any.
275 See RabbitMQ Cluster Formation guide: https://rabbitmq.com/cluster-
277 formation.html to learn more.
278 Example:
280 rabbitmq-diagnostics discover_peers --timeout 60
281 environment
283 See environment in rabbitmqctl(8)
284 erlang_cookie_hash
286 Outputs a hashed value of the shared secret used by the target node
288 to authenticate CLI tools and peers. The value can be compared with
289 the hash found in error messages of CLI tools.
290 See RabbitMQ Clustering guide:
292 https://rabbitmq.com/clustering.html#erlang-cookie to learn more.
293 Example:
295 rabbitmq-diagnostics erlang_cookie_hash -q
296 erlang_version
298 Reports target node's Erlang/OTP version.
300 Example:
302 rabbitmq-diagnostics erlang_version -q
303 is_booting
305 Reports if RabbitMQ application is currently booting (not
307 booted/running or stopped) on the target node.
308 Example:
310 rabbitmq-diagnostics is_booting
311 is_running
313 Reports if RabbitMQ application is fully booted and running (that
315 is, not stopped) on the target node.
316 Example:
318 rabbitmq-diagnostics is_running
319 list_bindings [-p vhost] [bindinginfoitem ...]
321 See list_bindings in rabbitmqctl(8)
323 list_channels [channelinfoitem ...]
325 See list_channels in rabbitmqctl(8)
327 list_ciphers
329 See list_ciphers in rabbitmqctl(8)
331 list_connections [connectioninfoitem ...]
333 See list_connections in rabbitmqctl(8)
335 list_consumers [-p vhost]
337 See list_consumers in rabbitmqctl(8)
339 list_exchanges [-p vhost] [exchangeinfoitem ...]
341 See list_exchanges in rabbitmqctl(8)
343 list_hashes
345 See list_hashes in rabbitmqctl(8)
347 list_queues [-p vhost] [--offline | --online | --local] [queueinfoitem ...]
349 See list_queues in rabbitmqctl(8)
351 ] [--local] [--queue-timeout milliseconds] [column ...]
352 [--no-table-headers]
353 list_unresponsive_queues
355 See list_unresponsive_queues in rabbitmqctl(8)
357 listeners
359 Lists listeners (bound sockets) on this node. Use this to inspect
361 what protocols and ports the node is listening on for client, CLI
362 tool and peer connections.
363 See RabbitMQ Networking guide: https://rabbitmq.com/networking.html
365 to learn more.
366 Example:
368 rabbitmq-diagnostics listeners
369 log_tail --number number | -N number [--timeout milliseconds]
371 Prints the last N lines of the log on the node
373 Example:
375 rabbitmq-diagnostics log_tail -number 100
376 log_tail_stream [--duration seconds | -d seconds] [--timeout milliseconds]
378 Streams logs from a running node for a period of time
380 Example:
382 rabbitmq-diagnostics log_tail_stream --duration 60
383 maybe_stuck
385 Periodically samples stack traces of all Erlang processes ("light‐
387 weight threads") on the node. Reports the processes for which stack
388 trace samples are identical.
389 Identical samples may indicate that the process is not making any
391 progress but is not necessarily an indication of a problem.
392 Example:
394 rabbitmq-diagnostics maybe_stuck -q
395 memory_breakdown [--unit memory_unit]
397 Displays node's memory usage by category. Supported memory units
399 are:
400 • bytes
402 • megabytes
404 • gigabytes
406 • terabytes
408 See RabbitMQ Memory Use guide: https://rabbitmq.com/memory-use.html
410 to learn more.
411 Example:
413 rabbitmq-diagnostics memory_breakdown --unit gigabytes
415 observer [--interval seconds]
417 Starts a CLI observer interface on the target node
419 Example:
421 rabbitmq-diagnostics observer --interval 10
422 ping
424 Most basic health check. Succeeds if target node (runtime) is run‐
426 ning and rabbitmq-diagnostics can authenticate with it success‐
427 fully.
428 report
430 See report in rabbitmqctl(8)
432 runtime_thread_stats [--sample-interval interval]
434 Performs sampling of runtime (kernel) threads' activity for
436 interval seconds and reports it.
437 For this command to work, Erlang/OTP on the target node must be
439 compiled with microstate accounting support and have the run‐
440 time_tools package available.
441 Example:
443 rabbitmq-diagnostics runtime_thread_stats --sample-interval
444 15
445 schema_info [--no_table_headers] [column ...] [--timeout milliseconds]
447 See schema_info in rabbitmqctl(8)
449 server_version
451 Reports target node's version.
453 Example:
455 rabbitmq-diagnostics server_version -q
456 status
458 See status in rabbitmqctl(8)
460 tls_versions
462 Lists all TLS versions supported by the runtime on the target node.
464 Note that RabbitMQ can be configured to only accept a subset of
465 those versions, for example, SSLv3 is disabled by default.
466 See RabbitMQ TLS guide: https://rabbitmq.com/ssl.html to learn
468 more.
469 Example:
471 rabbitmq-diagnostics tls_versions -q
472 Parameters
474 list_global_parameters
475 See list_global_parameters in rabbitmqctl(8)
477 list_parameters [-p vhost]
479 See list_parameters in rabbitmqctl(8)
481 Policies
483 list_operator_policies [-p vhost]
484 See list_operator_policies in rabbitmqctl(8)
486 list_policies [-p vhost]
488 See list_policies in rabbitmqctl(8)
490 Virtual hosts
492 list_vhost_limits [--vhost vhost] [--global] [--no-table-headers]
493 See list_vhost_limits in rabbitmqctl(8)
495 Node configuration
497 log_location [--all | -a] [--timeout milliseconds]
498 Shows log file location(s) on target node
500 Example:
502 rabbitmq-diagnostics log_location -a
503 Feature flags
505 list_feature_flags [column ...] [--timeout milliseconds]
506 See list_feature_flags in rabbitmqctl(8)
508 Queues
510 quorum_status queue [--vhost vhost]
511 See quorum_status in rabbitmq-queues(8)
513 check_if_node_is_mirror_sync_critical
515 See check_if_node_is_mirror_sync_critical in rabbitmq-queues(8)
517 check_if_node_is_quorum_critical
519 See check_if_node_is_quorum_critical in rabbitmq-queues(8)
521
523 rabbitmqctl(8), rabbitmq-server(8), rabbitmq-queues(8),
524 rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5),
525 rabbitmq-echopid(8)
526
528 The RabbitMQ Team <info@rabbitmq.com>
529RabbitMQ Server June 19, 2021 RabbitMQ Server