RabbitMQ

本文集文档发布于灏天文库

4.4 RabbitMQ 命令行工具 (rabbitmqctl)

文档摘要

4.4 RabbitMQ 命令行工具 (rabbitmqctl) 4.4 RabbitMQ 命令行工具 (rabbitmqctl) 详解：消息特性与保障的基石 在 RabbitMQ 的世界中，消息的可靠传输和高效管理至关重要。为了实现这些目标，RabbitMQ 提供了丰富的特性，例如消息持久化、消息确认机制、消息路由策略等。而要有效地配置、监控和管理这些特性，就离不开强大的命令行工具 。 不仅是 RabbitMQ 管理员的得力助手，更是深入理解和保障 RabbitMQ 消息特性的关键工具。 4.4.1 简介：RabbitMQ 的控制中心 是 RabbitMQ 提供的一个强大的命令行管理工具，它允许用户与 RabbitMQ Broker 进行交互，执行各种管理操作。

4.4 RabbitMQ 命令行工具 (rabbitmqctl)

4.4 RabbitMQ 命令行工具 (rabbitmqctl) 详解：消息特性与保障的基石

在 RabbitMQ 的世界中，消息的可靠传输和高效管理至关重要。为了实现这些目标，RabbitMQ 提供了丰富的特性，例如消息持久化、消息确认机制、消息路由策略等。而要有效地配置、监控和管理这些特性，就离不开强大的命令行工具 rabbitmqctl。rabbitmqctl 不仅是 RabbitMQ 管理员的得力助手，更是深入理解和保障 RabbitMQ 消息特性的关键工具。

4.4.1 rabbitmqctl 简介：RabbitMQ 的控制中心

rabbitmqctl 是 RabbitMQ 提供的一个强大的命令行管理工具，它允许用户与 RabbitMQ Broker 进行交互，执行各种管理操作。通过 rabbitmqctl，管理员可以监控 RabbitMQ 服务器的状态、配置用户和权限、管理 Virtual Host、Exchange、Queue、Binding、Policy 等核心组件，甚至进行集群管理和插件管理。

rabbitmqctl 的核心作用可以归纳为以下几点：

  • 状态监控与诊断： 实时查看 RabbitMQ 节点的运行状态、资源使用情况、连接数、队列深度等关键指标，帮助管理员及时发现和解决潜在问题，保障消息系统的稳定运行。

  • 配置管理： 灵活配置 RabbitMQ 的各项参数，包括用户权限、Virtual Host 设置、Exchange 和 Queue 的属性、Binding 规则、Policy 策略等，满足不同应用场景的需求。

  • 运维管理： 执行日常运维操作，例如启动/停止 RabbitMQ 服务、重启节点、清空队列、删除 Exchange 和 Queue、管理集群节点等，确保消息系统的正常运行和维护。

  • 故障排查： 在消息系统出现故障时，rabbitmqctl 可以提供丰富的诊断信息，例如查看错误日志、跟踪消息流向、分析队列状态等，帮助管理员快速定位问题根源，缩短故障恢复时间。

  • 自动化脚本： rabbitmqctl 可以与 Shell 脚本或其他自动化工具集成，实现 RabbitMQ 管理的自动化，提高运维效率，减少人工操作失误。

rabbitmqctl 与消息特性和保障的关系：

rabbitmqctl 在 RabbitMQ 消息特性与保障领域扮演着至关重要的角色。它通过以下方式来保障消息的可靠传输和管理：

  • 持久化配置： 通过 rabbitmqctl 可以配置 Exchange 和 Queue 的持久化属性，确保消息在 Broker 重启后不会丢失，从而保障消息的持久性。

  • 消息确认机制管理： rabbitmqctl 可以监控和管理消息的确认机制，例如查看未确认消息的数量、配置消费者的确认模式等，确保消息被可靠消费。

  • 队列和 Exchange 管理： 通过 rabbitmqctl 可以创建、删除和配置 Queue 和 Exchange，合理规划消息路由策略，确保消息能够正确地路由到目标队列，并被消费者正确处理。

  • 用户和权限管理： rabbitmqctl 可以管理 RabbitMQ 的用户和权限，控制用户对不同 Virtual Host、Exchange 和 Queue 的访问权限，保障消息系统的安全性。

  • Policy 策略配置： 通过 rabbitmqctl 可以配置 Policy 策略，例如死信队列策略、消息 TTL 策略、队列长度限制策略等，增强消息处理的灵活性和可靠性。

  • 集群管理与监控： rabbitmqctl 可以管理 RabbitMQ 集群，监控集群状态，确保集群的稳定运行，从而提高消息系统的可用性和容错能力。

总而言之，rabbitmqctl 是 RabbitMQ 管理的基石，它提供了强大的管理和监控能力，是实现和保障 RabbitMQ 消息特性的关键工具。

4.4.2 rabbitmqctl 安装与基本使用

安装 rabbitmqctl：

rabbitmqctl 通常与 RabbitMQ Server 一起安装。如果您已经安装了 RabbitMQ Server，那么 rabbitmqctl 应该已经可用。

  • Linux (基于 Debian/Ubuntu)： 通过 apt 安装 RabbitMQ Server 时，rabbitmqctl 通常会自动安装。

  • Linux (基于 RPM/CentOS)： 通过 yum 或 dnf 安装 RabbitMQ Server 时，rabbitmqctl 通常也会自动安装。

  • Windows： 在 Windows 上安装 RabbitMQ Server 时，rabbitmqctl.bat 脚本会安装在 RabbitMQ Server 的 sbin 目录下。

确认 rabbitmqctl 安装：

在终端或命令提示符中输入 rabbitmqctl，如果显示 rabbitmqctl 的帮助信息，则说明 rabbitmqctl 安装成功。

基本使用：

rabbitmqctl 的基本命令格式如下：

rabbitmqctl [options] command [command_options]
​

  • rabbitmqctl: 命令本身。

  • [options]: 全局选项，例如 -n <node> 指定要连接的 RabbitMQ 节点，-q 安静模式等。

  • command: 要执行的具体命令，例如 status, list_queues, add_user 等。

  • [command_options]: 命令的选项，例如 list_queues 命令可以使用 -p <vhost> 指定 Virtual Host。

常用全局选项：

  • -n <node>: 指定要连接的 RabbitMQ 节点。如果未指定，默认连接本地节点 rabbit@localhost。

  • -q: 安静模式，只输出命令结果，不输出其他信息。

  • -t <timeout>: 设置命令超时时间，单位为秒。

  • -c: 以集群模式执行命令，命令会在集群中的所有节点上执行。

  • -e: 如果命令执行失败，返回错误代码。

连接到远程 RabbitMQ 节点：

如果 RabbitMQ Server 运行在远程服务器上，可以使用 -n 选项指定远程节点连接：

rabbitmqctl -n rabbit@remote-host status
​

其中 rabbit@remote-host 需要替换为实际的 RabbitMQ 节点名称，通常是 rabbit@hostname 或 rabbit@IP地址。确保本地机器可以访问远程 RabbitMQ 节点的 5672 端口（默认 AMQP 端口）和 15672 端口（默认 Management UI 端口）。

权限要求：

执行 rabbitmqctl 命令通常需要具有 RabbitMQ 管理员权限的用户。默认情况下，guest 用户具有管理权限，但生产环境中强烈建议创建具有特定权限的用户，并禁用 guest 用户的远程访问。

4.4.3 rabbitmqctl 常用命令详解与实践

rabbitmqctl 提供了丰富的命令，涵盖了 RabbitMQ 管理的各个方面。以下将分类详细介绍一些常用的命令，并结合代码实践进行演示。

1. 基本状态与信息查询

这类命令用于获取 RabbitMQ Broker 的基本状态信息，帮助管理员了解 Broker 的运行状况。

  • status: 显示 RabbitMQ 节点的详细状态信息，包括 Erlang 运行时信息、应用信息、节点信息、进程信息、内存和磁盘使用情况等。

    rabbitmqctl status
​

    输出示例 (部分)：

    Status of node rabbit@localhost ...
[{pid,19000},
 {running_applications,[{rabbit,"RabbitMQ","3.9.13"},
                        {mnesia,"MNesia Database","4.19.1"},
                        {os_mon,"CPO  ncurses monitor","2.6.1"},
                        {rabbit_common, ...},
                        {stdlib,"ERTS  Libraries","9.3.3.7"},
                        {kernel,"ERTS  Kernel","6.4.2"}]},
 {os,{unix,linux}},
 {erlang_version,"Erlang/OTP 24 [erts-12.3.2.7] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:100] [jit]"},
 {memory,[{total,59156992},
          {connection_readers,0},
          {connection_writers,0},
          {connection_channels,0},
          {queue_procs,0},
          {queue_slave_procs,0},
          {plugins,311120},
          {other_proc,14398448},
          {mnesia,5362000},
          {mgmt_db,0},
          {msg_index,46560},
          {other_ets,1535264},
          {binary,24080},
          {policy_db,3520},
          {gc_mbuf,18448},
          {allocated_unused,23569440},
          {reserved_unallocated,24459264},
          {strategy_db,3520},
          {metrics_db,0}]},
 {alarms,[]},
 {listeners,[{clustering,25672,"::"},{amqp,5672,"::"},{amqp,5672,"0.0.0.0"},
             {http,15672,"::"},{https,15671,"::"}]},
 {vm_memory_high_watermark,0.4},
 {vm_memory_limit,1717986918},
 {disk_free_limit,50000000},
 {disk_free,21273456640}]
...
​

    解读： status 命令输出的信息非常丰富，包括 RabbitMQ 版本、Erlang 版本、操作系统信息、内存使用情况、监听端口、告警信息等。管理员可以通过分析这些信息，了解 Broker 的整体运行状况。例如，memory 部分显示了内存的详细使用情况，alarms 部分显示了当前的告警信息，listeners 部分显示了 Broker 监听的端口。

  • node_health_check: 执行节点健康检查，返回 ok 表示节点健康，否则返回错误信息。

    rabbitmqctl node_health_check
​

    输出示例 (健康)：

    Health check passed
​

    输出示例 (不健康)：

    Health check failed: [{disk_free,false}]
​

    解读： node_health_check 命令用于快速检查节点是否处于健康状态。如果返回 Health check passed，则表示节点运行正常。如果返回 Health check failed，则表示节点存在健康问题，需要进一步排查。错误信息会指示具体的问题，例如 disk_free,false 表示磁盘空间不足。

  • cluster_status: 显示 RabbitMQ 集群的状态信息，包括集群名称、节点列表、节点状态等。

    rabbitmqctl cluster_status
​

    输出示例 (单节点集群)：

    Cluster status of node rabbit@localhost ...
[{nodes,[{disc,[rabbit@localhost]}]},
 {running_nodes,[rabbit@localhost]},
 {cluster_name,<<"rabbit@localhost">>},
 {partitions,[]},
 {alarms,[]}]
​

    输出示例 (多节点集群)：

    Cluster status of node rabbit@node1 ...
[{nodes,[{disc,[rabbit@node1,rabbit@node2,rabbit@node3]}]},
 {running_nodes,[rabbit@node1,rabbit@node2,rabbit@node3]},
 {cluster_name,<<"my-rabbit-cluster">>},
 {partitions,[]},
 {alarms,[]}]
​

    解读： cluster_status 命令用于查看 RabbitMQ 集群的状态。输出信息包括集群中的节点列表、运行节点列表、集群名称、分区信息和告警信息。管理员可以通过此命令了解集群的拓扑结构和运行状况，尤其是在多节点集群环境中，可以方便地查看集群中所有节点的状态。

2. 用户与权限管理

这类命令用于管理 RabbitMQ 用户和权限，保障消息系统的安全性。

  • list_users: 列出所有 RabbitMQ 用户及其属性 (例如是否为管理员)。

    rabbitmqctl list_users
​

    输出示例：

    Listing users ...
guest           [administrator]
myuser          []
...done.
​

    解读： list_users 命令列出了 RabbitMQ 中所有用户及其角色。[administrator] 表示用户具有管理员权限，[] 表示用户没有管理员权限。默认的 guest 用户通常具有管理员权限。

  • add_user <username> <password>: 添加新用户。

    rabbitmqctl add_user mynewuser mypassword
​

    输出示例：

    Adding user "mynewuser" ...
...done.
​

  • delete_user <username>: 删除用户。

    rabbitmqctl delete_user mynewuser
​

    输出示例：

    Deleting user "mynewuser" ...
...done.
​

  • set_user_tags <username> <tag> ...: 设置用户标签，例如 administrator, monitoring, policymaker, management。

    rabbitmqctl set_user_tags mynewuser administrator monitoring
​

    输出示例：

    Setting tags for user "mynewuser" to [administrator,monitoring] ...
...done.
​

    常用用户标签：

    • administrator: 管理员权限，可以执行所有操作。

    • monitoring: 监控权限，可以访问监控相关资源。

    • policymaker: 策略制定者权限，可以管理 Policy 策略。

    • management: 管理权限，可以访问 Management UI。

  • clear_user_tags <username>: 清除用户的所有标签。

    rabbitmqctl clear_user_tags mynewuser
​

    输出示例：

    Clearing tags for user "mynewuser" ...
...done.
​

  • set_permissions -p <vhost> <username> <conf> <write> <read>: 设置用户在指定 Virtual Host 的权限。

    rabbitmqctl set_permissions -p my_vhost mynewuser ".*" ".*" ".*"
​

    参数说明：

    • -p <vhost>: 指定的 Virtual Host，例如 / 或 my_vhost。

    • <username>: 用户名。

    • <conf>: 配置权限正则表达式，用于匹配 Exchange 和 Queue 的名称，允许用户配置哪些 Exchange 和 Queue。".*" 表示允许配置所有。

    • <write>: 写权限正则表达式，用于匹配 Exchange 名称，允许用户向哪些 Exchange 发布消息。".*" 表示允许向所有 Exchange 发布消息。

    • <read>: 读权限正则表达式，用于匹配 Queue 名称，允许用户从哪些 Queue 消费消息。".*" 表示允许从所有 Queue 消费消息。

    输出示例：

    Setting permissions for user "mynewuser" in vhost "my_vhost" ...
...done.
​

  • clear_permissions -p <vhost> <username>: 清除用户在指定 Virtual Host 的权限。

    rabbitmqctl clear_permissions -p my_vhost mynewuser
​

    输出示例：

    Clearing permissions for user "mynewuser" in vhost "my_vhost" ...
...done.
​

  • list_permissions -p <vhost>: 列出指定 Virtual Host 的所有权限配置。

    rabbitmqctl list_permissions -p my_vhost
​

    输出示例：

    Listing permissions for vhost "my_vhost" ...
mynewuser     .*      .*      .*
...done.
​

    实践示例：创建用户并设置权限

    # 创建用户 myappuser，密码 myapppassword
rabbitmqctl add_user myappuser myapppassword
# 设置用户 myappuser 在 Virtual Host "/" 的权限，允许配置、写入和读取所有 Exchange 和 Queue
rabbitmqctl set_permissions -p / myappuser ".*" ".*" ".*"
# 列出 Virtual Host "/" 的权限配置，确认权限设置成功
rabbitmqctl list_permissions -p /
​

    mermaid graph TD 图示：用户与权限关系

    解释： 该图示展示了用户 myappuser 在 Virtual Host / 下的权限关系。用户被授予了配置、写入和读取所有 Exchange 和 Queue 的权限，这些权限通过正则表达式 .* 来表示。

3. Virtual Host 管理

Virtual Host (vhost) 是 RabbitMQ 中用于隔离 Exchange、Queue 和 Binding 的逻辑命名空间。

  • list_vhosts: 列出所有 Virtual Host。

    rabbitmqctl list_vhosts
​

    输出示例：

    Listing vhosts ...
/
my_vhost
...done.
​

  • add_vhost <vhost_name>: 添加新的 Virtual Host。

    rabbitmqctl add_vhost my_new_vhost
​

    输出示例：

    Adding vhost "my_new_vhost" ...
...done.
​

  • delete_vhost <vhost_name>: 删除 Virtual Host。

    rabbitmqctl delete_vhost my_new_vhost
​

    输出示例：

    Deleting vhost "my_new_vhost" ...
...done.
​

    注意： 删除 Virtual Host 会删除该 vhost 下的所有 Exchange、Queue、Binding 和权限配置，请谨慎操作。

  • set_vhost_limits -p <vhost> <limits>: 设置 Virtual Host 的资源限制（需要启用 rabbitmq_vhost_limits 插件）。

    rabbitmqctl set_vhost_limits -p my_vhost '{"max-queues": 100, "max-connections": 500}'
​

    参数说明：

    • -p <vhost>: 指定的 Virtual Host。

    • <limits>: JSON 格式的资源限制配置，例如 {"max-queues": 100, "max-connections": 500}。

    常用资源限制：

    • max-queues: Virtual Host 中队列的最大数量。

    • max-connections: Virtual Host 中连接的最大数量。

    • max-bindings: Virtual Host 中 Binding 的最大数量。

    • max-exchanges: Virtual Host 中 Exchange 的最大数量。

    实践示例：创建 Virtual Host 并设置资源限制

    # 创建 Virtual Host my_app_vhost
rabbitmqctl add_vhost my_app_vhost
# 设置 my_app_vhost 的队列数量限制为 50，连接数限制为 200
rabbitmqctl set_vhost_limits -p my_app_vhost '{"max-queues": 50, "max-connections": 200}'
# 列出 Virtual Host，确认 vhost 创建成功
rabbitmqctl list_vhosts
​

4. Exchange 管理

Exchange 是 RabbitMQ 消息路由的核心组件，负责接收生产者发布的消息，并根据路由规则将消息路由到一个或多个队列。

  • list_exchanges [-p <vhost>] [name]: 列出指定 Virtual Host (或所有 vhost) 的 Exchange 信息。可以指定 Exchange 名称进行过滤。

    rabbitmqctl list_exchanges -p my_vhost
rabbitmqctl list_exchanges -p my_vhost name type durable auto_delete
rabbitmqctl list_exchanges -p my_vhost amq.direct
​

    输出示例 (部分列)：

    Listing exchanges for vhost "my_vhost" ...
name            type    durable auto_delete
amq.direct      direct  true    false
my_exchange     topic   true    false
...done.
​

    常用列名： name, type, durable, auto_delete, internal。

  • declare_exchange [-p <vhost>] <exchange_name> <exchange_type> [options]: 声明 (创建) Exchange。

    rabbitmqctl declare_exchange -p my_vhost my_topic_exchange topic durable=true auto_delete=false
​

    常用选项：

    • type=<exchange_type>: Exchange 类型，例如 direct, topic, fanout, headers。

    • durable=<true|false>: 是否持久化，true 表示持久化，false 表示非持久化。持久化的 Exchange 在 Broker 重启后仍然存在。

    • auto_delete=<true|false>: 是否自动删除，true 表示当最后一个 Binding 解绑后自动删除，false 表示不自动删除。

    • internal=<true|false>: 是否为内部 Exchange，true 表示只能被 Exchange 路由到 Exchange，不能直接接收生产者发布的消息。

    • arguments=<json_arguments>: 其他参数，例如 Exchange 的扩展属性。

  • delete_exchange [-p <vhost>] <exchange_name> [if_unused]: 删除 Exchange。

    rabbitmqctl delete_exchange -p my_vhost my_topic_exchange
rabbitmqctl delete_exchange -p my_vhost my_temp_exchange if_unused
​

    if_unused 选项： 如果指定 if_unused，则只有当 Exchange 没有 Binding 时才会被删除，否则会报错。

  • list_exchange_bindings [-p <vhost>]: 列出指定 Virtual Host (或所有 vhost) 的 Exchange Binding 信息。

    rabbitmqctl list_exchange_bindings -p my_vhost
​

    输出示例 (部分)：

    Listing exchange bindings for vhost "my_vhost" ...
source name         source type     destination name    destination type    routing_key binding_arguments
amq.direct          exchange        exchange        amq.default         exchange
my_topic_exchange   exchange        queue           my_queue            queue           my.routing.key      []
...done.
​

    实践示例：创建 Exchange 并列出信息

    # 创建 topic 类型的持久化 Exchange my_app_exchange 在 Virtual Host my_app_vhost
rabbitmqctl declare_exchange -p my_app_vhost my_app_exchange topic durable=true auto_delete=false
# 列出 my_app_vhost 下的所有 Exchange 信息
rabbitmqctl list_exchanges -p my_app_vhost name type durable auto_delete
# 列出 my_app_exchange 的信息
rabbitmqctl list_exchanges -p my_app_vhost my_app_exchange name type durable auto_delete
​

5. Queue 管理

Queue 是 RabbitMQ 消息的存储容器，负责接收 Exchange 路由过来的消息，并等待消费者消费。

  • list_queues [-p <vhost>] [name] [options]: 列出指定 Virtual Host (或所有 vhost) 的 Queue 信息。可以指定 Queue 名称进行过滤，并选择要显示的列。

    rabbitmqctl list_queues -p my_vhost
rabbitmqctl list_queues -p my_vhost name messages consumers state
rabbitmqctl list_queues -p my_vhost my_queue
​

    常用列名： name, messages, messages_ready, messages_unacknowledged, consumers, state, durable, auto_delete, exclusive, arguments。

  • declare_queue [-p <vhost>] <queue_name> [options]: 声明 (创建) Queue。

    rabbitmqctl declare_queue -p my_vhost my_queue durable=true auto_delete=false exclusive=false
​

    常用选项：

    • durable=<true|false>: 是否持久化，true 表示持久化，false 表示非持久化。持久化的 Queue 在 Broker 重启后仍然存在。

    • auto_delete=<true|false>: 是否自动删除，true 表示当最后一个消费者取消订阅后自动删除，false 表示不自动删除。

    • exclusive=<true|false>: 是否排他队列，true 表示排他队列，只允许声明它的连接访问，连接断开后自动删除，false 表示非排他队列。

    • arguments=<json_arguments>: 其他参数，例如 Queue 的扩展属性，例如死信队列配置、消息 TTL 配置、队列最大长度限制等。

  • delete_queue [-p <vhost>] <queue_name> [if_unused] [if_empty]: 删除 Queue。

    rabbitmqctl delete_queue -p my_vhost my_queue
rabbitmqctl delete_queue -p my_vhost my_temp_queue if_unused if_empty
​

    if_unused 选项： 如果指定 if_unused，则只有当 Queue 没有消费者时才会被删除，否则会报错。

    if_empty 选项： 如果指定 if_empty，则只有当 Queue 中没有消息时才会被删除，否则会报错。

  • purge_queue [-p <vhost>] <queue_name>: 清空 Queue 中的所有消息。

    rabbitmqctl purge_queue -p my_vhost my_queue
​

    注意： purge_queue 命令会永久删除 Queue 中的所有消息，请谨慎操作。

  • list_queue_bindings [-p <vhost>] <queue_name>: 列出指定 Queue 的 Binding 信息。

    rabbitmqctl list_queue_bindings -p my_vhost my_queue
​

    实践示例：创建 Queue 并配置死信队列

    # 创建死信 Exchange dlx.exchange (fanout 类型，持久化)
rabbitmqctl declare_exchange -p my_vhost dlx.exchange fanout durable=true auto_delete=false
# 创建死信 Queue dlx.queue (持久化)
rabbitmqctl declare_queue -p my_vhost dlx.queue durable=true auto_delete=false
# 将死信 Exchange 绑定到死信 Queue，路由键为空
rabbitmqctl bind_queue -p my_vhost dlx.queue dlx.exchange ""
# 创建正常 Queue my_app_queue，配置死信队列参数
rabbitmqctl declare_queue -p my_vhost my_app_queue durable=true auto_delete=false exclusive=false arguments='{"x-dead-letter-exchange": "dlx.exchange"}'
# 列出 my_app_queue 的信息，确认死信队列配置生效
rabbitmqctl list_queues -p my_vhost name durable auto_delete exclusive arguments
​
发布者: 作者: 转发
评论区 (0)
U
0/500