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:
15 https://rabbitmq.com/documentation.html
16 to learn more about RabbitMQ diagnostics, monitoring and health checks.
17 rabbitmq-diagnostics allows the operator to inspect node and cluster
19 state. A number of health checks are available to be used interactively
20 and by monitoring tools.
21 By default if it is not possible to connect to and authenticate with the
24 target node (for example if it is stopped), the operation will fail. To
25 learn more, see the RabbitMQ Monitoring guide:
26 https://rabbitmq.com/monitoring.html
27
29 -n node
30 Default node is "rabbit@target-hostname", where target-hostname
31 is the local host. On a host named "myserver.example.com", the
32 node name will usually be "rabbit@myserver" (unless
33 RABBITMQ_NODENAME has been overridden). The output of "hostname
34 -s" is usually the correct suffix to use after the "@" sign. See
35 rabbitmq-server(8) for details of configuring a RabbitMQ node.
36 -q, --quiet
38 Quiet output mode is selected. Informational messages are
39 reduced when quiet mode is in effect.
40 -s, --silent
42 Silent output mode is selected. Informational messages are
43 reduced and table headers are suppressed when silent mode is in
44 effect.
45 -t timeout, --timeout timeout
47 Operation timeout in seconds. Not all commands support timeouts.
48 Default is infinity.
49 -l, --longnames
51 Must be specified when the cluster is configured to use long
52 (FQDN) node names. To learn more, see the RabbitMQ Clustering
53 guide:
54 https://rabbitmq.com/clustering.html
55 --erlang-cookie cookie
57 Shared secret to use to authenticate to the target node. Prefer
58 using a local file or the RABBITMQ_ERLANG_COOKIE environment
59 variable instead of specifying this option on the command line.
60 To learn more, see the RabbitMQ CLI Tools guide:
61 https://rabbitmq.com/cli.html
62
64 Most commands provided by rabbitmq-diagnostics inspect node and cluster
65 state or perform health checks.
66 Commands that list topology entities (e.g. queues) use tab as column
68 delimiter. These commands and their arguments are delegated to rabbit‐
69 mqctl(8).
70 Some commands ( list_queues, list_exchanges, list_bindings and
72 list_consumers) accept an optional vhost parameter.
73 The list_queues, list_exchanges and list_bindings commands accept an
75 optional virtual host parameter for which to display results. The
76 default value is "/".
77 Help
79 help [-l] [command_name]
80 Prints usage for all available commands.
82 -l, --list-commands
84 List command usages only, without parameter explanation.
85 command_name
87 Prints usage for the specified command.
88 version
90 Displays CLI tools version
92 Nodes
94 wait
95 See wait in rabbitmqctl(8)
97 Cluster
99 cluster_status
100 See cluster_status in rabbitmqctl(8)
102 Users
104 list_users
105 See list_users in rabbitmqctl(8)
107 Access Control
109 list_permissions [-p vhost]
110 See list_permissions in rabbitmqctl(8)
112 list_topic_permissions [-p vhost]
114 See list_topic_permissions in rabbitmqctl(8)
116 list_user_permissions username
118 See list_user_permissions in rabbitmqctl(8)
120 list_user_topic_permissions username
122 See list_user_topic_permissions in rabbitmqctl(8)
124 list_vhosts [vhostinfoitem ...]
126 See list_vhosts in rabbitmqctl(8)
128 Monitoring, observability and health checks
130 alarms
131 Lists resource alarms, if any, in the cluster.
133 See RabbitMQ Resource Alarms guide:
135 https://rabbitmq.com/alarms.html
136 to learn more.
137 Example:
139 rabbitmq-diagnostics alarms
140 certificates
142 Displays the node certificates for every listener on target node
144 that is configured to use TLS.
145 Example:
147 rabbitmq-diagnostics certificates
149 check_alarms
151 Health check that fails (returns with a non-zero code) if there are
153 alarms in effect on any of the cluster nodes.
154 See RabbitMQ Resource Alarms guide:
156 https://rabbitmq.com/alarms.html
157 to learn more.
158 Example:
160 rabbitmq-diagnostics check_alarms
161 check_certificate_expiration [--unit time_unit] [--within seconds]
163 Checks the expiration date on the certificates for every listener
165 on target node that is configured to use TLS. Supported time units
166 are:
167 · days
169 · weeks
171 · months
173 · years
175 Example:
177 rabbitmq-diagnostics check_certificate_expiration --unit
178 weeks --within 6
179 check_local_alarms
181 Health check that fails (returns with a non-zero code) if there are
183 alarms in effect on the target node.
184 See RabbitMQ Resource Alarms guide:
186 https://rabbitmq.com/alarms.html
187 to learn more.
188 Example:
190 rabbitmq-diagnostics check_local_alarms
191 check_port_connectivity
193 Health check that fails (returns with a non-zero code) if any lis‐
195 tener ports on the target node cannot accept a new TCP connection
196 opened by rabbitmq-diagnostics
197 The check only validates if a new TCP connection is accepted. It
199 does not perform messaging protocol handshake or authenticate.
200 See RabbitMQ Networking guide:
202 https://rabbitmq.com/networking.html
203 to learn more.
204 Example:
206 rabbitmq-diagnostics check_port_connectivity
207 check_port_listener port
209 Health check that fails (returns with a non-zero code) if the tar‐
211 get node is not listening on the specified port (there is no lis‐
212 tener that uses that port).
213 See RabbitMQ Networking guide:
215 https://rabbitmq.com/networking.html
216 to learn more.
217 Example:
219 rabbitmq-diagnostics check_port_listener 5672
220 check_protocol_listener protocol
222 Health check that fails (returns with a non-zero code) if the tar‐
224 get node does not have a listener for the specified protocol.
225 See RabbitMQ Networking guide:
227 https://rabbitmq.com/networking.html
228 to learn more.
229 Example:
231 rabbitmq-diagnostics check_protocol_listener mqtt
232 check_running
234 Health check that fails (returns with a non-zero code) if the Rab‐
236 bitMQ application is not running on the target node.
237 If rabbitmqctl(8) was used to stop the application, this check will
239 fail.
240 Example:
242 rabbitmq-diagnostics check_running
243 check_virtual_hosts
245 Health check that checks if all vhosts are running in the target
247 node
248 Example:
250 rabbitmq-diagnostics check_virtual_hosts --timeout 60
251 cipher_suites
253 Lists cipher suites enabled by default. To list all available
255 cipher suites, add the --all argument.
256 Example:
258 rabbitmq-diagnostics cipher_suites --format openssl --all
259 command_line_arguments
261 Displays target node's command-line arguments and flags as reported
263 by the runtime.
264 Example:
266 rabbitmq-diagnostics command_line_arguments -n
267 rabbit@hostname
268 consume_event_stream [--duration seconds | -d seconds] [--pattern pattern]
270 [--timeout milliseconds]
271 Streams internal events from a running node. Output is jq-compati‐
273 ble.
274 Example:
276 rabbitmq-diagnostics consume_event_stream -n rabbit@hostname
277 --duration 20 --pattern queue_.*
278 discover_peers
280 Runs a peer discovery on the target node and prints the discovered
282 nodes, if any.
283 See RabbitMQ Cluster Formation guide:
285 https://rabbitmq.com/cluster-formation.html
286 to learn more.
287 Example:
289 rabbitmq-diagnostics discover_peers --timeout 60
290 environment
292 See environment in rabbitmqctl(8)
293 erlang_cookie_hash
295 Outputs a hashed value of the shared secret used by the target node
297 to authenticate CLI tools and peers. The value can be compared with
298 the hash found in error messages of CLI tools.
299 See RabbitMQ Clustering guide:
301 https://rabbitmq.com/clustering.html#erlang-cookie
302 to learn more.
303 Example:
305 rabbitmq-diagnostics erlang_cookie_hash -q
306 erlang_version
308 Reports target node's Erlang/OTP version.
310 Example:
312 rabbitmq-diagnostics erlang_version -q
313 is_booting
315 Reports if RabbitMQ application is currently booting (not
317 booted/running or stopped) on the target node.
318 Example:
320 rabbitmq-diagnostics is_booting
321 is_running
323 Reports if RabbitMQ application is fully booted and running (that
325 is, not stopped) on the target node.
326 Example:
328 rabbitmq-diagnostics is_running
329 list_bindings [-p vhost] [bindinginfoitem ...]
331 See list_bindings in rabbitmqctl(8)
333 list_channels [channelinfoitem ...]
335 See list_channels in rabbitmqctl(8)
337 list_ciphers
339 See list_ciphers in rabbitmqctl(8)
341 list_connections [connectioninfoitem ...]
343 See list_connections in rabbitmqctl(8)
345 list_consumers [-p vhost]
347 See list_consumers in rabbitmqctl(8)
349 list_exchanges [-p vhost] [exchangeinfoitem ...]
351 See list_exchanges in rabbitmqctl(8)
353 list_hashes
355 See list_hashes in rabbitmqctl(8)
357 list_queues [-p vhost] [--offline | --online | --local] [queueinfoitem ...]
359 See list_queues in rabbitmqctl(8)
361 ] [--local] [--queue_timeout milliseconds] [column ...]
362 [--no-table-headers]
363 list_unresponsive_queues
365 See list_unresponsive_queues in rabbitmqctl(8)
367 listeners
369 Lists listeners (bound sockets) on this node. Use this to inspect
371 what protocols and ports the node is listening on for client, CLI
372 tool and peer connections.
373 See RabbitMQ Networking guide:
375 https://rabbitmq.com/networking.html
376 to learn more.
377 Example:
379 rabbitmq-diagnostics listeners
380 log_tail --number number | -N number [--timeout milliseconds]
382 Prints the last N lines of the log on the node
384 Example:
386 rabbitmq-diagnostics log_tail -number 100
387 log_tail_stream [--duration seconds | -d seconds] [--timeout milliseconds]
389 Streams logs from a running node for a period of time
391 Example:
393 rabbitmq-diagnostics log_tail_stream --duration 60
394 maybe_stuck
396 Periodically samples stack traces of all Erlang processes ("light‐
398 weight threads") on the node. Reports the processes for which stack
399 trace samples are identical.
400 Identical samples may indicate that the process is not making any
402 progress but is not necessarily an indication of a problem.
403 Example:
405 rabbitmq-diagnostics maybe_stuck -q
406 memory_breakdown [--unit memory_unit]
408 Displays node's memory usage by category. Supported memory units
410 are:
411 · bytes
413 · megabytes
415 · gigabytes
417 · terabytes
419 See RabbitMQ Memory Use guide:
421 https://rabbitmq.com/memory-use.html
422 to learn more.
423 Example:
425 rabbitmq-diagnostics memory_breakdown --unit gigabytes
427 observer [--interval seconds]
429 Starts a CLI observer interface on the target node
431 Example:
433 rabbitmq-diagnostics observer --interval 10
434 ping
436 Most basic health check. Succeeds if target node (runtime) is run‐
438 ning and rabbitmq-diagnostics can authenticate with it success‐
439 fully.
440 report
442 See report in rabbitmqctl(8)
444 runtime_thread_stats [--sample-interval interval]
446 Performs sampling of runtime (kernel) threads' activity for
448 interval seconds and reports it.
449 For this command to work, Erlang/OTP on the target node must be
451 compiled with microstate accounting support and have the run‐
452 time_tools package available.
453 Example:
455 rabbitmq-diagnostics runtime_thread_stats --sample-interval
456 15
457 schema_info [--no_table_headers] [column ...] [--timeout milliseconds]
459 See schema_info in rabbitmqctl(8)
461 server_version
463 Reports target node's version.
465 Example:
467 rabbitmq-diagnostics server_version -q
468 status
470 See status in rabbitmqctl(8)
472 tls_versions
474 Lists all TLS versions supported by the runtime on the target node.
476 Note that RabbitMQ can be configured to only accept a subset of
477 those versions, for example, SSLv3 is disabled by default.
478 See RabbitMQ TLS guide:
480 https://rabbitmq.com/ssl.html
481 to learn more.
482 Example:
484 rabbitmq-diagnostics tls_versions -q
485 Parameters
487 list_global_parameters
488 See list_global_parameters in rabbitmqctl(8)
490 list_parameters [-p vhost]
492 See list_parameters in rabbitmqctl(8)
494 Policies
496 list_operator_policies [-p vhost]
497 See list_operator_policies in rabbitmqctl(8)
499 list_policies [-p vhost]
501 See list_policies in rabbitmqctl(8)
503 Virtual hosts
505 list_vhost_limits [--vhost vhost] [--global] [--no-table-headers]
506 See list_vhost_limits in rabbitmqctl(8)
508 Node configuration
510 log_location [--all | -a] [--timeout milliseconds]
511 Shows log file location(s) on target node
513 Example:
515 rabbitmq-diagnostics log_location -a
516 Feature flags
518 list_feature_flags [column ...] [--timeout milliseconds]
519 See list_feature_flags in rabbitmqctl(8)
521 Queues
523 quorum_status queue [--vhost vhost]
524 See quorum_status in rabbitmqctl(8)
526
528 rabbitmqctl(8), rabbitmq-server(8), rabbitmq-queues(8),
529 rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5),
530 rabbitmq-echopid(8)
531
533 The RabbitMQ Team <info@rabbitmq.com>
534RabbitMQ Server September 28, 2019 RabbitMQ Server