1"use strict";(self.webpackChunkrabbitmq_website=self.webpackChunkrabbitmq_website||[]).push([["21023"],{25219(s,e,l){l.r(e),l.d(e,{metadata:()=>c,default:()=>h,frontMatter:()=>r,contentTitle:()=>a,toc:()=>t,assets:()=>n});var c=JSON.parse('{"id":"man/rabbitmq-diagnostics.8","title":"rabbitmq-diagnostics.8","description":"NAME","source":"@site/docs/man/rabbitmq-diagnostics.8.md","sourceDirName":"man","slug":"/man/rabbitmq-diagnostics.8","permalink":"/docs/next/man/rabbitmq-diagnostics.8","draft":false,"unlisted":false,"editUrl":"https://github.com/rabbitmq/rabbitmq-website/tree/main/docs/man/rabbitmq-diagnostics.8.md","tags":[],"version":"current","frontMatter":{}}'),i=l(74848),d=l(28453);let r={},a,n={},t=[{value:"NAME",id:"NAME",level:2},{value:"SYNOPSIS",id:"SYNOPSIS",level:2},{value:"DESCRIPTION",id:"DESCRIPTION",level:2},{value:"OPTIONS",id:"OPTIONS",level:2},{value:'<code class="Fl">-n</code> <var class="Ar">node</var>',id:"n",level:3},{value:'<code class="Fl">-q</code>, <code class="Fl">--quiet</code>',id:"q",level:3},{value:'<code class="Fl">-s</code>, <code class="Fl">--silent</code>',id:"s",level:3},{value:'<code class="Fl">-t</code> <var class="Ar">timeout</var>, <code class="Fl">--timeout</code> <var class="Ar">timeout</var>',id:"t",level:3},{value:'<code class="Fl">-l</code>, <code class="Fl">--longnames</code>',id:"l",level:3},{value:'<code class="Fl">--erlang-cookie</code> <var class="Ar">cookie</var>',id:"erlang-cookie",level:3},{value:"COMMANDS",id:"COMMANDS",level:2},{value:"Help",id:"Help",level:3},{value:'<code class="Cm">help</code> [<code class="Fl">-l</code>] [<var class="Ar">command_name</var>]',id:"help",level:4},{value:'<code class="Fl">-l</code>, <code class="Fl">--list-commands</code>',id:"l~2",level:4},{value:'<code class="Cm">version</code>',id:"version",level:4},{value:"Nodes",id:"Nodes",level:3},{value:'<code class="Cm">wait</code>',id:"wait",level:4},{value:"Cluster",id:"Cluster",level:3},{value:'<code class="Cm">cluster_status</code>',id:"cluster_status",level:4},{value:"Users",id:"Users",level:3},{value:'<code class="Cm">list_users</code>',id:"list_users",level:4},{value:"Access Control",id:"Access_Control",level:3},{value:'<code class="Cm">list_permissions</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>]',id:"list_permissions",level:4},{value:'<code class="Cm">list_topic_permissions</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>]',id:"list_topic_permissions",level:4},{value:'<code class="Cm">list_user_permissions</code> <var class="Ar">username</var>',id:"list_user_permissions",level:4},{value:'<code class="Cm">list_user_topic_permissions</code> <var class="Ar">username</var>',id:"list_user_topic_permissions",level:4},{value:'<code class="Cm">list_vhosts</code> [<var class="Ar">vhostinfoitem ...</var>]',id:"list_vhosts",level:4},{value:"Monitoring, observability and health checks",id:"Monitoring,_observability_and_health_checks",level:3},{value:'<code class="Cm">alarms</code>',id:"alarms",level:4},{value:'<code class="Cm">certificates</code>',id:"certificates",level:4},{value:'<code class="Cm">check_alarms</code>',id:"check_alarms",level:4},{value:'<code class="Cm">check_certificate_expiration</code> [<code class="Fl">--unit</code> <var class="Ar">time_unit</var>] [<code class="Fl">--within</code> <var class="Ar">seconds</var>]',id:"check_certificate_expiration",level:4},{value:'<code class="Cm">check_local_alarms</code>',id:"check_local_alarms",level:4},{value:'<code class="Cm">check_port_connectivity</code>',id:"check_port_connectivity",level:4},{value:'<code class="Cm">check_port_listener</code> <var class="Ar">port</var>',id:"check_port_listener",level:4},{value:'<code class="Cm">check_protocol_listener</code> <var class="Ar">protocol</var>',id:"check_protocol_listener",level:4},{value:'<code class="Cm">check_running</code>',id:"check_running",level:4},{value:'<code class="Cm">check_virtual_hosts</code>',id:"check_virtual_hosts",level:4},{value:'<code class="Cm">cipher_suites</code>',id:"cipher_suites",level:4},{value:'<code class="Cm">command_line_arguments</code>',id:"command_line_arguments",level:4},{value:'<code class="Cm">consume_event_stream</code> [<code class="Fl">--duration</code> <var class="Ar">seconds</var> | <code class="Fl">-d</code> <var class="Ar">seconds</var>] [<code class="Fl">--pattern</code> <var class="Ar">pattern</var>] [<code class="Fl">--timeout</code> <var class="Ar">milliseconds</var>]',id:"consume_event_stream",level:4},{value:'<code class="Cm">discover_peers</code>',id:"discover_peers",level:4},{value:'<code class="Cm">environment</code>',id:"environment",level:4},{value:'<code class="Cm">erlang_cookie_hash</code>',id:"erlang_cookie_hash",level:4},{value:'<code class="Cm">erlang_version</code>',id:"erlang_version",level:4},{value:'<code class="Cm">is_booting</code>',id:"is_booting",level:4},{value:'<code class="Cm">is_running</code>',id:"is_running",level:4},{value:'<code class="Cm">list_bindings</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>] [<var class="Ar">bindinginfoitem ...</var>]',id:"list_bindings",level:4},{value:'<code class="Cm">list_channels</code> [<var class="Ar">channelinfoitem ...</var>]',id:"list_channels",level:4},{value:'<code class="Cm">list_ciphers</code>',id:"list_ciphers",level:4},{value:'<code class="Cm">list_connections</code> [<var class="Ar">connectioninfoitem ...</var>]',id:"list_connections",level:4},{value:'<code class="Cm">list_consumers</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>]',id:"list_consumers",level:4},{value:'<code class="Cm">list_exchanges</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>] [<var class="Ar">exchangeinfoitem ...</var>]',id:"list_exchanges",level:4},{value:'<code class="Cm">list_hashes</code>',id:"list_hashes",level:4},{value:'<code class="Cm">list_queues</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>] [<code class="Fl">--offline</code> | <code class="Fl">--online</code> | <code class="Fl">--local</code>] [<var class="Ar">queueinfoitem ...</var>]',id:"list_queues",level:4},{value:'<code class="Cm">list_unresponsive_queues</code> [<code class="Fl">--local</code>] [<code class="Fl">--queue-timeout</code> <var class="Ar">milliseconds</var>] [<var class="Ar">column ...</var>] [<code class="Fl">--no-table-headers</code>]',id:"list_unresponsive_queues",level:4},{value:'<code class="Cm">listeners</code>',id:"listeners",level:4},{value:'<code class="Cm">log_tail</code> [<code class="Fl">--number</code> <var class="Ar">number</var> | <code class="Fl">-N</code> <var class="Ar">number</var> [<code class="Fl">--timeout</code> <var class="Ar">milliseconds</var>]',id:"log_tail",level:4},{value:'<code class="Cm">log_tail_stream</code> [<code class="Fl">--duration</code> <var class="Ar">seconds</var> | <code class="Fl">-d</code> <var class="Ar">seconds</var>] [<code class="Fl">--timeout</code> <var class="Ar">milliseconds</var>]',id:"log_tail_stream",level:4},{value:'<code class="Cm">maybe_stuck</code>',id:"maybe_stuck",level:4},{value:'<code class="Cm">memory_breakdown</code> [<code class="Fl">--unit</code> <var class="Ar">memory_unit</var>]',id:"memory_breakdown",level:4},{value:'<code class="Cm">observer</code> [<code class="Fl">--interval</code> <var class="Ar">seconds</var>]',id:"observer",level:4},{value:'<code class="Cm">ping</code>',id:"ping",level:4},{value:'<code class="Cm">report</code>',id:"report",level:4},{value:'<code class="Cm">runtime_thread_stats</code> [<code class="Fl">--sample-interval</code> <var class="Ar">interval</var>]',id:"runtime_thread_stats",level:4},{value:'<code class="Cm">schema_info</code> [<code class="Fl">--no_table_headers</code>] [<var class="Ar">column ...</var>] [<code class="Fl">--timeout</code> <var class="Ar">milliseconds</var>]',id:"schema_info",level:4},{value:'<code class="Cm">server_version</code>',id:"server_version",level:4},{value:'<code class="Cm">status</code>',id:"status",level:4},{value:'<code class="Cm">tls_versions</code>',id:"tls_versions",level:4},{value:"Parameters",id:"Parameters",level:3},{value:'<code class="Cm">list_global_parameters</code>',id:"list_global_parameters",level:4},{value:'<code class="Cm">list_parameters</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>]',id:"list_parameters",level:4},{value:"Policies",id:"Policies",level:3},{value:'<code class="Cm">list_operator_policies</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>]',id:"list_operator_policies",level:4},{value:'<code class="Cm">list_policies</code> [<code class="Fl">-p</code> <var class="Ar">vhost</var>]',id:"list_policies",level:4},{value:"Virtual hosts",id:"Virtual_hosts",level:3},{value:'<code class="Cm">list_vhost_limits</code> [<code class="Fl">--vhost</code> <var class="Ar">vhost</var>] [<code class="Fl">--global</code>] [<code class="Fl">--no-table-headers</code>]',id:"list_vhost_limits",level:4},{value:"Node configuration",id:"Node_configuration",level:3},{value:'<code class="Cm">log_location</code> [<code class="Fl">--all</code> | <code class="Fl">-a</code>] [<code class="Fl">--timeout</code> <var class="Ar">milliseconds</var>]',id:"log_location",level:4},{value:"Feature flags",id:"Feature_flags",level:3},{value:'<code class="Cm">list_feature_flags</code> [<var class="Ar">column ...</var>] [<code class="Fl">--timeout</code> <var class="Ar">milliseconds</var>]',id:"list_feature_flags",level:4},{value:"Queues",id:"Queues",level:3},{value:'<code class="Cm">quorum_status</code> <var class="Ar">queue</var> [<code class="Fl">--vhost</code> <var class="Ar">vhost</var>]',id:"quorum_status",level:4},{value:'<code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code>',id:"check_if_cluster_has_classic_queue_mirroring_policy",level:4},{value:'<code class="Cm">check_if_node_is_quorum_critical</code>',id:"check_if_node_is_quorum_critical",level:4},{value:"SEE ALSO",id:"SEE_ALSO",level:2},{value:"AUTHOR",id:"AUTHOR",level:2}];function o(s){let e={a:"a",h2:"h2",h3:"h3",h4:"h4",p:"p",...(0,d.R)(),...s.components};return(0,i.jsxs)("div",{class:"manual-text",children:[(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"NAME",children:"NAME"}),(0,i.jsxs)("p",{class:"Pp",children:[(0,i.jsx)("code",{class:"Nm",children:"rabbitmq-diagnostics"})," \u2014 ",(0,i.jsx)("span",{class:"Nd",children:"RabbitMQ diagnostics, monitoring and health checks tools"})]})]}),(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"SYNOPSIS",children:"SYNOPSIS"}),(0,i.jsx)("table",{class:"Nm",children:(0,i.jsxs)("tr",{children:[(0,i.jsx)("td",{children:(0,i.jsx)("code",{class:"Nm",children:"rabbitmq-diagnostics"})}),(0,i.jsxs)("td",{children:["[",(0,i.jsx)("code",{class:"Fl",children:"-q"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"-s"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"-l"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"-n"})," ",(0,i.jsx)("var",{class:"Ar",children:"node"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"-t"})," ",(0,i.jsx)("var",{class:"Ar",children:"timeout"}),"] ",(0,i.jsx)("var",{class:"Ar",children:"command"})," [",(0,i.jsx)("var",{class:"Ar",children:"command_options"}),"]"]})]})})]}),(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"DESCRIPTION",children:"DESCRIPTION"}),(0,i.jsxs)("p",{class:"Pp",children:[(0,i.jsx)("code",{class:"Nm",children:"rabbitmq-diagnostics"})," is a command line tool that provides commands used for diagnostics, monitoring and health checks of RabbitMQ nodes. See the ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs",children:"RabbitMQ documentation guides"})," to learn more about RabbitMQ diagnostics, monitoring and health checks."]}),(0,i.jsxs)("p",{class:"Pp",children:[(0,i.jsx)("code",{class:"Nm",children:"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."]}),(0,i.jsx)("p",{class:"Pp"}),(0,i.jsxs)("p",{class:"Pp",children:["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 ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/monitoring",children:"RabbitMQ Monitoring guide"})]})]}),(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"OPTIONS",children:"OPTIONS"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h3,{id:"n",children:[(0,i.jsx)("code",{class:"Fl",children:"-n"})," ",(0,i.jsx)("var",{class:"Ar",children:"node"})]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)(e.p,{children:['Default node is "rabbit@',(0,i.jsx)("var",{class:"Ar",children:"target-hostname"}),'", where ',(0,i.jsx)("var",{class:"Ar",children:"target-hostname"}),' is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless ',(0,i.jsx)("code",{class:"Ev",children:"RABBITMQ_NODENAME"}),' has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See ',(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-server.8",children:"rabbitmq-server(8)"})," for details of configuring a RabbitMQ node."]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h3,{id:"q",children:[(0,i.jsx)("code",{class:"Fl",children:"-q"}),", ",(0,i.jsx)("code",{class:"Fl",children:"--quiet"})]})}
1),(0,i.jsx)("dd",{children:"Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect."}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h3,{id:"s",children:[(0,i.jsx)("code",{class:"Fl",children:"-s"}),", ",(0,i.jsx)("code",{class:"Fl",children:"--silent"})]})}),(0,i.jsx)("dd",{children:"Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect."}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h3,{id:"t",children:[(0,i.jsx)("code",{class:"Fl",children:"-t"})," ",(0,i.jsx)("var",{class:"Ar",children:"timeout"}),", ",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"timeout"})]})}),(0,i.jsxs)("dd",{children:["Operation timeout in seconds. Not all commands support timeouts. Default is ",(0,i.jsx)("code",{class:"Cm",children:"infinity"}),"."]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h3,{id:"l",children:[(0,i.jsx)("code",{class:"Fl",children:"-l"}),", ",(0,i.jsx)("code",{class:"Fl",children:"--longnames"})]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)(e.p,{children:["Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/clustering",children:"RabbitMQ Clustering guide"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h3,{id:"erlang-cookie",children:[(0,i.jsx)("code",{class:"Fl",children:"--erlang-cookie"})," ",(0,i.jsx)("var",{class:"Ar",children:"cookie"})]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)(e.p,{children:["Shared secret to use to authenticate to the target node. Prefer using a local file or the ",(0,i.jsx)("code",{class:"Ev",children:"RABBITMQ_ERLANG_COOKIE"})," environment variable instead of specifying this option on the command line. To learn more, see the ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/cli",children:"RabbitMQ CLI Tools guide"})]})})]})]}),(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"COMMANDS",children:"COMMANDS"}),(0,i.jsxs)("p",{class:"Pp",children:["Most commands provided by ",(0,i.jsx)("code",{class:"Nm",children:"rabbitmq-diagnostics"})," inspect node and cluster state or perform health checks."]}),(0,i.jsx)("p",{class:"Pp",children:"Commands that list topology entities (e.g. queues) use tab as column delimiter. These commands and their arguments are delegated to rabbitmqctl(8)."}),(0,i.jsxs)("p",{class:"Pp",children:["Some commands ( ",(0,i.jsx)("code",{class:"Cm",children:"list_queues"}),", ",(0,i.jsx)("code",{class:"Cm",children:"list_exchanges"}),", ",(0,i.jsx)("code",{class:"Cm",children:"list_bindings"})," and ",(0,i.jsx)("code",{class:"Cm",children:"list_consumers"}),") accept an optional ",(0,i.jsx)("var",{class:"Ar",children:"vhost"})," parameter."]}),(0,i.jsxs)("p",{class:"Pp",children:["The ",(0,i.jsx)("code",{class:"Cm",children:"list_queues"}),", ",(0,i.jsx)("code",{class:"Cm",children:"list_exchanges"})," and ",(0,i.jsx)("code",{class:"Cm",children:"list_bindings"}),' commands accept an optional virtual host parameter for which to display results. The default value is "/".']}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Help",children:"Help"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"help",children:[(0,i.jsx)("code",{class:"Cm",children:"help"})," [",(0,i.jsx)("code",{class:"Fl",children:"-l"}),"] [",(0,i.jsx)("var",{class:"Ar",children:"command_name"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Prints usage for all available commands."}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"l~2",children:[(0,i.jsx)("code",{class:"Fl",children:"-l"}),", ",(0,i.jsx)("code",{class:"Fl",children:"--list-commands"})]})}),(0,i.jsx)("dd",{children:"List command usages only, without parameter explanation."}),(0,i.jsx)("dt",{children:(0,i.jsx)("var",{class:"Ar",children:"command_name"})}),(0,i.jsx)("dd",{children:"Prints usage for the specified command."})]})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"version",children:(0,i.jsx)("code",{class:"Cm",children:"version"})})}),(0,i.jsx)("dd",{children:(0,i.jsx)("p",{class:"Pp",children:"Displays CLI tools version"})})]}),(0,i.jsx)("dl",{class:"Bl-tag"})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Nodes",children:"Nodes"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"wait",children:(0,i.jsx)("code",{class:"Cm",children:"wait"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"wait"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Cluster",children:"Cluster"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"cluster_status",children:(0,i.jsx)("code",{class:"Cm",children:"cluster_status"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"cluster_status"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Users",children:"Users"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"list_users",children:(0,i.jsx)("code",{class:"Cm",children:"list_users"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_users"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Access_Control",children:"Access Control"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_permissions",children:[(0,i.jsx)("code",{class:"Cm",children:"list_permissions"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_permissions"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_topic_permissions",children:[(0,i.jsx)("code",{class:"Cm",children:"list_topic_permissions"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_topic_permissions"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_user_permissions",children:[(0,i.jsx)("code",{class:"Cm",children:"list_user_permissions"})," ",(0,i.jsx)("var",{class:"Ar",children:"username"})]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_user_permissions"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_user_topic_permissions",children:[(0,i.jsx)("code",{class:"Cm",children:"list_user_topic_permissions"})," ",(0,i.jsx)("var",{class:"Ar",children:"username"})]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_user_topic_permissions"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_vhosts",children:[(0,i.jsx)("code",{class:"Cm",children:"list_vhosts"})," [",(0,i.jsx)("var",{class:"Ar",children:"vhostinfoitem ..."}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_vhosts"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Monitoring,_observability_and_health_checks",children:"Monitoring, observability and health checks"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"alarms",children:(0,i.jsx)("code",{class:"Cm",children:"alarms"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Lists resource alarms, if any, in the cluster."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/alarms",children:"RabbitMQ Resource Alarms guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics alarms"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"certificates",children:(0,i.jsx)("code",{class:"Cm",children:"certificates"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Displays the node certificates for every listener on target node that is configured to use TLS."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("p",{class:"Pp"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics certificates"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_alarms",children:(0,i.jsx)("code",{class:"Cm",children:"check_alarms"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Health check that fails (returns with a non-zero code) if there are alarms in effect on any of the cluster nodes."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/alarms",children:"RabbitMQ Resource Alarms guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_alarms"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"check_certificate_expiration",children:[(0,i.jsx)("code",{class:"Cm",children:"check_certificate_expiration"})," [",(0,i.jsx)("code",{class:"Fl",children:"--unit"})," ",(0,i.jsx)("var",{class:"Ar",children:"time_unit"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--within"})," ",(0,i.jsx)("var",{class:"Ar",children:"seconds"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Checks the expiration date on the certificates for every listener on target node that is configured to use TLS. Supported time units are:"}),(0,i.jsxs)("ul",{class:"Bl-bullet",children:[(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"days"})}),(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"weeks"})}),(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"months"})}),(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"years"})})]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_certificate_expiration --unit weeks --within 6"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_local_alarms",children:(0,i.jsx)("code",{class:"Cm",children:"check_local_alarms"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Health check that fails (returns with a non-zero code) if there are alarms in effect on the target node."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/alarms",children:"RabbitMQ Resource Alarms guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_local_alarms"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_port_connectivity",children:(0,i.jsx)("code",{class:"Cm",children:"check_port_connectivity"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsxs)("p",{class:"Pp",children:["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 ",(0,i.jsx)("code",{class:"Nm",children:"rabbitmq-diagnostics"})]}),(0,i.jsx)("p",{class:"Pp",children:"The check only validates if a new TCP connection is accepted. It does not perform messaging protocol handshake or authenticate."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/networking",children:"RabbitMQ Networking guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_port_connectivity"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"check_port_listener",children:[(0,i.jsx)("code",{class:"Cm",children:"check_port_listener"})," ",(0,i.jsx)("var",{class:"Ar",children:"port"})]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"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)."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/networking",children:"RabbitMQ Networking guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_port_listener 5672"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"check_protocol_listener",children:[(0,i.jsx)("code",{class:"Cm",children:"check_protocol_listener"})," ",(0,i.jsx)("var",{class:"Ar",children:"protocol"})]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Health check that fails (returns with a non-zero code) if the target node does not have a listener for the specified protocol."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/networking",children:"RabbitMQ Networking guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_protocol_listener mqtt"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_running",children:(0,i.jsx)("code",{class:"Cm",children:"check_running"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Health check that fails (returns with a non-zero code) if the RabbitMQ application is not running on the target node."}),(0,i.jsxs)("p",{class:"Pp",children:["If ",(0,i.jsx)("code",{class:"Cm",children:"rabbitmqctl(8)"})," was used to stop the application, this check will fail."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_running"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_virtual_hosts",children:(0,i.jsx)("code",{class:"Cm",children:"check_virtual_hosts"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Health check that checks if all vhosts are running in the target node"}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics check_virtual_hosts --timeout 60"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"cipher_suites",children:(0,i.jsx)("code",{class:"Cm",children:"cipher_suites"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Lists cipher suites enabled by default. To list all available cipher suites, add the --all argument."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics cipher_suites --format openssl --all"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"command_line_arguments",children:(0,i.jsx)("code",{class:"Cm",children:"command_line_arguments"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Displays target node's command-line arguments and flags as reported by the runtime."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{cl
1ass:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics command_line_arguments -n rabbit@hostname"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"consume_event_stream",children:[(0,i.jsx)("code",{class:"Cm",children:"consume_event_stream"})," [",(0,i.jsx)("code",{class:"Fl",children:"--duration"})," ",(0,i.jsx)("var",{class:"Ar",children:"seconds"})," | ",(0,i.jsx)("code",{class:"Fl",children:"-d"})," ",(0,i.jsx)("var",{class:"Ar",children:"seconds"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--pattern"})," ",(0,i.jsx)("var",{class:"Ar",children:"pattern"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Streams internal events from a running node. Output is jq-compatible."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics consume_event_stream -n rabbit@hostname --duration 20 --pattern queue_.*"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"discover_peers",children:(0,i.jsx)("code",{class:"Cm",children:"discover_peers"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Runs a peer discovery on the target node and prints the discovered nodes, if any."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/cluster-formation",children:"RabbitMQ Cluster Formation guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics discover_peers --timeout 60"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"environment",children:(0,i.jsx)("code",{class:"Cm",children:"environment"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)(e.p,{children:["See ",(0,i.jsx)("code",{class:"Cm",children:"environment"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"erlang_cookie_hash",children:(0,i.jsx)("code",{class:"Cm",children:"erlang_cookie_hash"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"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."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/clustering#erlang-cookie",children:"RabbitMQ Clustering guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics erlang_cookie_hash -q"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"erlang_version",children:(0,i.jsx)("code",{class:"Cm",children:"erlang_version"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Reports target node's Erlang/OTP version."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics erlang_version -q"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"is_booting",children:(0,i.jsx)("code",{class:"Cm",children:"is_booting"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Reports if RabbitMQ application is currently booting (not booted/running or stopped) on the target node."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics is_booting"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"is_running",children:(0,i.jsx)("code",{class:"Cm",children:"is_running"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Reports if RabbitMQ application is fully booted and running (that is, not stopped) on the target node."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics is_running"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_bindings",children:[(0,i.jsx)("code",{class:"Cm",children:"list_bindings"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"] [",(0,i.jsx)("var",{class:"Ar",children:"bindinginfoitem ..."}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_bindings"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_channels",children:[(0,i.jsx)("code",{class:"Cm",children:"list_channels"})," [",(0,i.jsx)("var",{class:"Ar",children:"channelinfoitem ..."}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_channels"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"list_ciphers",children:(0,i.jsx)("code",{class:"Cm",children:"list_ciphers"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_ciphers"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_connections",children:[(0,i.jsx)("code",{class:"Cm",children:"list_connections"})," [",(0,i.jsx)("var",{class:"Ar",children:"connectioninfoitem ..."}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_connections"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_consumers",children:[(0,i.jsx)("code",{class:"Cm",children:"list_consumers"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_consumers"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_exchanges",children:[(0,i.jsx)("code",{class:"Cm",children:"list_exchanges"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"] [",(0,i.jsx)("var",{class:"Ar",children:"exchangeinfoitem ..."}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_exchanges"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"list_hashes",children:(0,i.jsx)("code",{class:"Cm",children:"list_hashes"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_hashes"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_queues",children:[(0,i.jsx)("code",{class:"Cm",children:"list_queues"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--offline"})," | ",(0,i.jsx)("code",{class:"Fl",children:"--online"})," | ",(0,i.jsx)("code",{class:"Fl",children:"--local"}),"] [",(0,i.jsx)("var",{class:"Ar",children:"queueinfoitem ..."}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_queues"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_unresponsive_queues",children:[(0,i.jsx)("code",{class:"Cm",children:"list_unresponsive_queues"})," [",(0,i.jsx)("code",{class:"Fl",children:"--local"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--queue-timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"] [",(0,i.jsx)("var",{class:"Ar",children:"column ..."}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--no-table-headers"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_unresponsive_queues"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"listeners",children:(0,i.jsx)("code",{class:"Cm",children:"listeners"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"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."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/networking",children:"RabbitMQ Networking guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics listeners"})})]}),(0,i.jsxs)("dt",{children:[(0,i.jsxs)(e.h4,{id:"log_tail",children:[(0,i.jsx)("code",{class:"Cm",children:"log_tail"})," [",(0,i.jsx)("code",{class:"Fl",children:"--number"})," ",(0,i.jsx)("var",{class:"Ar",children:"number"})," | ",(0,i.jsx)("code",{class:"Fl",children:"-N"})," ",(0,i.jsx)("var",{class:"Ar",children:"number"})," [",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"]"]}),(0,i.jsxs)(e.p,{children:["Prints the last N lines of the log on the node",(0,i.jsx)("br",{})]}),(0,i.jsx)("br",{}),(0,i.jsx)("br",{}),(0,i.jsxs)(e.p,{children:["Example:",(0,i.jsx)("br",{})]}),(0,i.jsx)("br",{})]}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics log_tail --number 100"})}),(0,i.jsx)(e.p,{children:"]"})]}),(0,i.jsx)("dd",{children:"\xa0"}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"log_tail_stream",children:[(0,i.jsx)("code",{class:"Cm",children:"log_tail_stream"})," [",(0,i.jsx)("code",{class:"Fl",children:"--duration"})," ",(0,i.jsx)("var",{class:"Ar",children:"seconds"})," | ",(0,i.jsx)("code",{class:"Fl",children:"-d"})," ",(0,i.jsx)("var",{class:"Ar",children:"seconds"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Streams logs from a running node for a period of time"}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics log_tail_stream --duration 60"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"maybe_stuck",children:(0,i.jsx)("code",{class:"Cm",children:"maybe_stuck"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:'Perio
1dically samples stack traces of all Erlang processes ("lightweight threads") on the node. Reports the processes for which stack trace samples are identical.'}),(0,i.jsx)("p",{class:"Pp",children:"Identical samples may indicate that the process is not making any progress but is not necessarily an indication of a problem."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics maybe_stuck -q"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"memory_breakdown",children:[(0,i.jsx)("code",{class:"Cm",children:"memory_breakdown"})," [",(0,i.jsx)("code",{class:"Fl",children:"--unit"})," ",(0,i.jsx)("var",{class:"Ar",children:"memory_unit"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Displays node's memory usage by category. Supported memory units are:"}),(0,i.jsxs)("ul",{class:"Bl-bullet",children:[(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"bytes"})}),(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"megabytes"})}),(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"gigabytes"})}),(0,i.jsx)("li",{children:(0,i.jsx)(e.p,{children:"terabytes"})})]}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/memory-use",children:"RabbitMQ Memory Use guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("p",{class:"Pp"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics memory_breakdown --unit gigabytes"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"observer",children:[(0,i.jsx)("code",{class:"Cm",children:"observer"})," [",(0,i.jsx)("code",{class:"Fl",children:"--interval"})," ",(0,i.jsx)("var",{class:"Ar",children:"seconds"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Starts a CLI observer interface on the target node"}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics observer --interval 10"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"ping",children:(0,i.jsx)("code",{class:"Cm",children:"ping"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["Most basic health check. Succeeds if target node (runtime) is running and ",(0,i.jsx)("code",{class:"Nm",children:"rabbitmq-diagnostics"})," can authenticate with it successfully."]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"report",children:(0,i.jsx)("code",{class:"Cm",children:"report"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"report"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"runtime_thread_stats",children:[(0,i.jsx)("code",{class:"Cm",children:"runtime_thread_stats"})," [",(0,i.jsx)("code",{class:"Fl",children:"--sample-interval"})," ",(0,i.jsx)("var",{class:"Ar",children:"interval"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsxs)("p",{class:"Pp",children:["Performs sampling of runtime (kernel) threads' activity for ",(0,i.jsx)("var",{class:"Ar",children:"interval"})," seconds and reports it."]}),(0,i.jsx)("p",{class:"Pp",children:"For this command to work, Erlang/OTP on the target node must be compiled with microstate accounting support and have the runtime_tools package available."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics runtime_thread_stats --sample-interval 15"})})]}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"schema_info",children:[(0,i.jsx)("code",{class:"Cm",children:"schema_info"})," [",(0,i.jsx)("code",{class:"Fl",children:"--no_table_headers"}),"] [",(0,i.jsx)("var",{class:"Ar",children:"column ..."}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"schema_info"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"server_version",children:(0,i.jsx)("code",{class:"Cm",children:"server_version"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Reports target node's version."}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics server_version -q"})})]}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"status",children:(0,i.jsx)("code",{class:"Cm",children:"status"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"status"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"tls_versions",children:(0,i.jsx)("code",{class:"Cm",children:"tls_versions"})})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Lists all TLS versions supp
1orted by the runtime on the target node. Note that RabbitMQ can be configured to only accept a subset of those versions, for example, SSLv3 is deactivated by default."}),(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("a",{class:"Lk",href:"https://www.rabbitmq.com/docs/ssl",children:"RabbitMQ TLS guide"})," to learn more."]}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics tls_versions -q"})})]})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Parameters",children:"Parameters"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"list_global_parameters",children:(0,i.jsx)("code",{class:"Cm",children:"list_global_parameters"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_global_parameters"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_parameters",children:[(0,i.jsx)("code",{class:"Cm",children:"list_parameters"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_parameters"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Policies",children:"Policies"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_operator_policies",children:[(0,i.jsx)("code",{class:"Cm",children:"list_operator_policies"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_operator_policies"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_policies",children:[(0,i.jsx)("code",{class:"Cm",children:"list_policies"})," [",(0,i.jsx)("code",{class:"Fl",children:"-p"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_policies"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Virtual_hosts",children:"Virtual hosts"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_vhost_limits",children:[(0,i.jsx)("code",{class:"Cm",children:"list_vhost_limits"})," [",(0,i.jsx)("code",{class:"Fl",children:"--vhost"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--global"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--no-table-headers"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_vhost_limits"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Node_configuration",children:"Node configuration"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"log_location",children:[(0,i.jsx)("code",{class:"Cm",children:"log_location"})," [",(0,i.jsx)("code",{class:"Fl",children:"--all"})," | ",(0,i.jsx)("code",{class:"Fl",children:"-a"}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"]"]})}),(0,i.jsxs)("dd",{children:[(0,i.jsx)("p",{class:"Pp",children:"Shows log file location(s) on target node"}),(0,i.jsx)("p",{class:"Pp",children:"Example:"}),(0,i.jsx)("div",{class:"Bd Bd-indent lang-bash",children:(0,i.jsx)("code",{class:"Li",children:"rabbitmq-diagnostics log_location -a"})})]})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Feature_flags",children:"Feature flags"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"list_feature_flags",children:[(0,i.jsx)("code",{class:"Cm",children:"list_feature_flags"})," [",(0,i.jsx)("var",{class:"Ar",children:"column ..."}),"] [",(0,i.jsx)("code",{class:"Fl",children:"--timeout"})," ",(0,i.jsx)("var",{class:"Ar",children:"milliseconds"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"list_feature_flags"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"})]})})]})]}),(0,i.jsxs)("section",{class:"Ss",children:[(0,i.jsx)(e.h3,{id:"Queues",children:"Queues"}),(0,i.jsxs)("dl",{class:"Bl-tag",children:[(0,i.jsx)("dt",{children:(0,i.jsxs)(e.h4,{id:"quorum_status",children:[(0,i.jsx)("code",{class:"Cm",children:"quorum_status"})," ",(0,i.jsx)("var",{class:"Ar",children:"queue"})," [",(0,i.jsx)("code",{class:"Fl",children:"--vhost"})," ",(0,i.jsx)("var",{class:"Ar",children:"vhost"}),"]"]})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"quorum_status"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-queues.8",children:"rabbitmq-queues(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_if_cluster_has_classic_queue_mirroring_policy",children:(0,i.jsx)("code",{class:"Cm",children:"check_if_cluster_has_classic_queue_mirroring_policy"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"check_if_cluster_has_classic_queue_mirroring_policy"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-queues.8",children:"rabbitmq-queues(8)"})]})}),(0,i.jsx)("dt",{children:(0,i.jsx)(e.h4,{id:"check_if_node_is_quorum_critical",children:(0,i.jsx)("code",{class:"Cm",children:"check_if_node_is_quorum_critical"})})}),(0,i.jsx)("dd",{children:(0,i.jsxs)("p",{class:"Pp",children:["See ",(0,i.jsx)("code",{class:"Cm",children:"check_if_node_is_quorum_critical"})," in ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-queues.8",children:"rabbitmq-queues(8)"})]})})]})]})]}),(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"SEE_ALSO",children:"SEE ALSO"}),(0,i.jsxs)("p",{class:"Pp",children:[(0,i.jsx)("a",{class:"Xr",href:"rabbitmqctl.8",children:"rabbitmqctl(8)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-server.8",children:"rabbitmq-server(8)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-queues.8",children:"rabbitmq-queues(8)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-streams.8",children:"rabbitmq-streams(8)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-upgrade.8",children:"rabbitmq-upgrade(8)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-service.8",children:"rabbitmq-service(8)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-env.conf.5",children:"rabbitmq-env.conf(5)"}),", ",(0,i.jsx)("a",{class:"Xr",href:"rabbitmq-echopid.8",children:"rabbitmq-echopid(8)"})]})]}),(0,i.jsxs)("section",{class:"Sh",children:[(0,i.jsx)(e.h2,{id:"AUTHOR",children:"AUTHOR"}),(0,i.jsxs)("p",{class:"Pp",children:[(0,i.jsx)("span",{class:"An",children:"The RabbitMQ Team"}
1)," <",(0,i.jsx)("a",{class:"Mt",href:"mailto:[email protected]",children:(0,i.jsx)(e.a,{href:"mailto:[email protected]",children:"[email protected]"})}),">"]})]})]})}function h(s={}){let{wrapper:e}={...(0,d.R)(),...s.components};return e?(0,i.jsx)(e,{...s,children:(0,i.jsx)(o,{...s})}):o(s)}},28453(s,e,l){l.d(e,{R:()=>r,x:()=>a});var c=l(96540);let i={},d=c.createContext(i);function r(s){let e=c.useContext(d);return c.useMemo(function(){return"function"==typeof s?s(e):{...e,...s}},[e,s])}function a(s){let e;return e=s.disableParentContext?"function"==typeof s.components?s.components(i):s.components||i:r(s.components),c.createElement(d.Provider,{value:e},s.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.