/usr/lib/rabbitmq/bin/rabbitmq-diagnostics

warning: the VM is running with native name encoding of latin1 which may cause Elixir to malfunction as it expects utf8. Please ensure your locale is set to UTF-8 (which can be verified by running "locale" in your shell) or set the ELIXIR_ERL_OPTIONS="+fnu" environment variable

Usage

rabbitmq-diagnostics [--node <node>] [--timeout <timeout>] [--longnames] [--quiet] <command> [<command options>]

Available commands:

Help:

   autocomplete                                                   Provides command name autocomplete variants
   help                                                           Displays usage information for a command
   version                                                        Displays CLI tools version

Nodes:

   wait                                                           Waits for RabbitMQ node startup by monitoring a local PID file. See also 'rabbitmqctl await_online_nodes'

Cluster:

   cluster_status                                                 Displays all the nodes in the cluster grouped by node type, together with the currently running nodes

Users:

   list_user_limits                                               Displays configured user limits
   list_users                                                     List user names and tags

Access Control:

   list_permissions                                               Lists user permissions in a virtual host
   list_topic_permissions                                         Lists topic permissions in a virtual host
   list_user_permissions                                          Lists permissions of a user across all virtual hosts
   list_user_topic_permissions                                    Lists user topic permissions
   list_vhosts                                                    Lists virtual hosts

Monitoring, observability and health checks:

   activate_free_disk_space_monitoring                            [Re-]activates free disk space monitoring on a node
   alarms                                                         Lists resource alarms (local or cluster-wide) in effect on the target node
   check_alarms                                                   Health check that exits with a non-zero code if the target node reports any alarms, local or cluster-wide.
   check_certificate_expiration                                   Checks the expiration date of every certificate (leaf, intermediary or any CA) in every certificate bundle file used by the node
   check_for_quorum_queues_without_an_elected_leader              Checks that quorum queue have elected and available leader replicas
   check_if_any_deprecated_features_are_used                      Generate a report listing all deprecated features in use
   check_if_cluster_has_classic_queue_mirroring_policy            Health check that exits with a non-zero code if there are policies that enable classic queue mirroring
   check_if_metadata_store_is_initialized                         Health check that exits with a non-zero code if the metadata store on target node has not yet finished initializing
   check_if_metadata_store_is_initialized_with_data               Health check that exits with a non-zero code if the metadata store on target node has not yet finished initializing
   check_if_new_quorum_queue_replicas_have_finished_initial_sync  Health check that exits with a non-zero code if there are queues that run promotable replicas on the current node.
   check_if_node_is_quorum_critical                               Health check that exits with a non-zero code if there are queues/streams with minimum online quorum (queues/streams that will lose their quorum if the target node shuts down)
   check_port_connectivity                                        Basic TCP connectivity health check for each listener's port on the target node
   check_port_listener                                            Health check that exits with a non-zero code if target node does not have an active listener for given port
   check_protocol_listener                                        Health check that exits with a non-zero code if target node does not have an active listener for given protocol
   check_running                                                  Health check that exits with a non-zero code if the RabbitMQ app on the target node is not running
   check_virtual_hosts                                            Health check that checks if all vhosts are running in the target node
   cipher_suites                                                  Lists cipher suites enabled by default. To list all available cipher suites, add the --all argument.
   consume_event_stream                                           Streams internal events from a running node. Output is jq-compatible.
   coordinator_status                                             Displays raft status of the stream coordinator
   deactivate_free_disk_space_monitoring                          Deactivates free disk space monitoring on a node
   discover_peers                                                 Performs peer discovery and lists discovered nodes, if any
   erlang_version                                                 Displays Erlang/OTP version on the target node
   is_booting                                                     Checks if RabbitMQ is still booting on the target node
   is_running                                                     Checks if RabbitMQ is fully booted and running on the target node
   list_bindings                                                  Lists all bindings on a vhost
   list_channel_interceptors                                      Lists registered channel interceptors with their name, intercepted AMQP operations, and priority
   list_channels                                                  Lists all channels in the node
   list_ciphers                                                   Lists cipher suites supported by encoding commands
   list_connections                                               Lists AMQP connections for the node
   list_consumers                                                 Lists all consumers for a vhost
   list_exchanges                                                 Lists exchanges
   list_hashes                                                    Lists hash functions supported by encoding commands
   list_network_interfaces                                        Lists network interfaces (NICs) on the target node
   list_node_auth_attempt_stats                                   Lists authentication attempts on the target node
   list_operator_policies_with_classic_queue_mirroring            List all operator policies that enable classic queue mirroring
   list_policies_with_classic_queue_mirroring                     List all policies that enable classic queue mirroring
   list_queues                                                    Lists queues and their properties
   list_unresponsive_queues                                       Tests queues to respond within timeout. Lists those which did not respond
   listeners                                                      Lists active connection listeners (bound interface, port, protocol) on the target node
   log_tail                                                       Prints the last N lines of the log on the node
   log_tail_stream                                                Streams logs from a running node for a period of time
   maybe_stuck                                                    Detects Erlang processes ("lightweight threads") potentially not making progress on the target node
   memory_breakdown                                               Provides a memory usage breakdown on the target node.
   message_size_stats                                             Displays message size distribution statistics aggregated across all cluster nodes
   metadata_store_status                                          Displays quorum status of Khepri metadata store
   observer                                                       Starts a CLI observer interface on the target node
   ping                                                           Checks that the node OS process is up, registered with EPMD and CLI tools can authenticate with it
   quorum_status                                                  Displays the quorum status of a queue
   remote_shell                                                   Starts an interactive Erlang shell on the target node
   report                                                         Generate a server status report containing a concatenation of all server status information for support purposes
   runtime_thread_stats                                           Provides a breakdown of runtime thread activity stats on the target node
   server_version                                                 Displays server version on the target node
   sole_connection_status                                         Displays raft status of the AMQP 1.0 sole connection enforcement feature
   status                                                         Displays status of a node
   stream_status                                                  Displays the status of a stream
   tls_versions                                                   Lists TLS versions supported (but not necessarily allowed) on the target node

Parameters:

   list_global_parameters                                         Lists global runtime parameters
   list_parameters                                                Lists runtime parameters for a virtual host

Policies:

   list_operator_policies                                         Lists operator policy overrides for a virtual host
   list_policies                                                  Lists all policies in a virtual host
   list_policies_that_match                                       Lists all policies matching a queue/exchange (only the highest priority policy is active)

Virtual hosts:

   list_vhost_limits                                              Displays configured virtual host limits

Upgrade:

   has_reached_target_cluster_size                                Health check that exits with a non-zero code if the cluster has not yet reached its target size

Configuration and Environment:

   certificates                                                   Displays certificates (public keys) for every listener on target node that is configured to use TLS
   command_line_arguments                                         Displays target node's command-line arguments and flags as reported by the runtime
   disable_auth_attempt_source_tracking                           Disables the tracking of peer IP address and username of authentication attempts
   enable_auth_attempt_source_tracking                            Enables the tracking of peer IP address and username of authentication attempts
   environment                                                    Displays the name and value of each variable in the application environment for each running application
   erlang_cookie_hash                                             Displays a hash of the Erlang cookie (shared secret) used by the target node
   erlang_cookie_sources                                          Display Erlang cookie source (e.g. $HOME/.erlang.cookie file) information useful for troubleshooting
   log_location                                                   Shows log file location(s) on target node
   os_env                                                         Lists RabbitMQ-specific environment variables set on target node
   reset_node_auth_attempt_metrics                                Resets auth attempt metrics on the target node
   resolve_hostname                                               Resolves a hostname to a set of addresses. Takes Erlang's inetrc file into account.
   resolver_info                                                  Displays effective hostname resolver (inetrc) configuration on target node

Feature flags:

   list_deprecated_features                                       Lists deprecated features
   list_feature_flags                                             Lists feature flags

Operations:

   reclaim_quorum_memory                                          Requests a full sweep GC on all of a quorum queue's Erlang processes

Deprecated:

   check_if_node_is_mirror_sync_critical                          DEPRECATED. Mirrored queues were removed in RabbitMQ 4.0. This command is a no-op.
   check_local_alarms                                             DEPRECATED. This command is a no-op. Local alarms have been removed. See https://www.rabbitmq.com/alarms.html
   node_health_check                                              DEPRECATED. This command is a no-op. See https://www.rabbitmq.com/monitoring.html#health-checks

Use 'rabbitmq-diagnostics help <command>' to learn more about a specific command