rabbitmq-streams.8

名称

rabbitmq-streams — RabbitMQ 流管理工具

语法

rabbitmq-streams

[-q] [-s] [-l] [-n 节点] [-t 超时时间] 命令 [命令选项]

描述

rabbitmq-streams 是一个命令行工具，提供用于管理流的命令，例如添加或删除流副本。请参阅 RabbitMQ 流概述。

选项

-n 节点

默认节点为“rabbit@目标主机名”，其中 目标主机名 为本地主机。在名为“myserver.example.com”的主机上，节点名称通常为“rabbit@myserver”（除非已覆盖 RABBITMQ_NODENAME）。“hostname -s”的输出通常是“@”符号后使用的正确后缀。有关配置 RabbitMQ 节点的详细信息，请参阅 rabbitmq-server(8)。

-q, --quiet

选中静默输出模式。启用静默模式时，信息消息会减少。

-s, --silent

选中静默输出模式。启用静默模式时，信息消息会减少，并且表标题会被抑制。

-t 超时时间, --timeout 超时时间

操作超时时间（秒）。并非所有命令都支持超时。默认值为 无限。

-l, --longnames

当集群配置为使用长（FQDN）节点名称时，必须指定此选项。要了解更多信息，请参阅 RabbitMQ 集群指南

--erlang-cookie cookie

用于向目标节点进行身份验证的共享密钥。建议使用本地文件或 RABBITMQ_ERLANG_COOKIE 环境变量，而不是在命令行上指定此选项。要了解更多信息，请参阅 RabbitMQ CLI 工具指南

命令

help

显示 rabbitmq-streams 支持的常规帮助和命令。

复制

add_replica 队列 节点 --vhost 虚拟主机

在给定节点上添加流副本。

示例

rabbitmq-streams add_replica --vhost "a-vhost" "a-queue" "rabbit@new-node"

delete_replica 队列 节点 --vhost 虚拟主机

删除给定节点上的流副本。

示例

rabbitmq-streams delete_replica --vhost "a-vhost" "a-queue" "rabbit@decomissioned-node"

监控、可观察性和健康检查

stream_status 流 --vhost 虚拟主机

显示流的状态。

示例

rabbitmq-streams stream_status --vhost "a-vhost" "a-stream"

restart_stream 流 --vhost 虚拟主机 ---preferred-leader-node 节点

重新启动流及其所有副本。可选的首选节点标志指示命令在重新启动期间尝试将领导者放置在特定节点上。

示例

rabbitmq-streams restart_stream --vhost "a-vhost" "a-stream" --preferred-leader-node "node"

策略

set_stream_retention_policy 流 策略 --vhost 虚拟主机

设置流的保留策略。

示例

rabbitmq-streams set_stream_retention_policy --vhost "a-vhost" "a-stream" "a-policy"

流插件

list_stream_connections [连接信息项 ...]

返回流协议连接统计信息。

连接信息项 参数用于指示要包含在结果中的连接信息项。结果中的列顺序将与参数的顺序匹配。连接信息项 可以取以下列表中的任何值

auth_mechanism

使用的 SASL 身份验证机制，例如“PLAIN”。

client_properties

客户端在连接建立期间传输的信息属性。

conn_name

连接的可读名称。

connected_at

此连接建立的日期和时间，以时间戳表示。

connection_state

连接状态；以下之一

• 运行中

• 已阻止

frame_max

最大帧大小（字节）。

heartbeat

协商的心跳间隔（秒）。

host

通过反向 DNS 获取的服务器主机名，或者如果反向 DNS 失败或被禁用，则为其 IP 地址。

peer_cert_issuer

对等方 SSL 证书的发行者，采用 RFC4514 格式。

peer_cert_subject

对等方 SSL 证书的主题，采用 RFC4514 格式。

peer_cert_validity

对等方 SSL 证书的有效期。

peer_host

通过反向 DNS 获取的对等方主机名，或者如果反向 DNS 失败或未启用，则为其 IP 地址。

peer_port

对等方端口。

port

服务器端口。

ssl

布尔值，指示连接是否使用 SSL 保护。

ssl_cipher

SSL 密码算法（例如“aes_256_cbc”）。

ssl_hash

SSL 哈希函数（例如“sha”）。

ssl_key_exchange

SSL 密钥交换算法（例如“rsa”）。

ssl_protocol

SSL 协议（例如“tlsv1”）。

subscriptions

连接上的订阅（消费者）数量。

user

与连接关联的用户名。

vhost

虚拟主机名称，其中非 ASCII 字符以 C 中的方式转义。

如果未指定任何 连接信息项，则仅显示 conn_name。

例如，此命令显示每个连接的连接名称和用户

rabbitmq-streams list_stream_connections conn_name user

list_stream_consumers [-p vhost] [消费者信息项 ...]

返回附加到流的消费者。

The 消费者信息项 参数用于指示要包含在结果中的消费者信息项。结果中的列顺序将与参数的顺序匹配。消费者信息项 可以取以下列表中的任何值

活动

布尔值，指示消费者是否处于活动状态。

活动状态

消费者活动状态；以下之一

• 启动

• 单一活动

• 等待

连接 PID

与消费者连接关联的 Erlang 进程的 ID。

信用额度

消费者的可用信用额度。

已消费消息

消费者已消费的消息数量。

偏移量

消费者所在的偏移量（流中的位置）。

偏移量延迟

消费者最后存储的偏移量与最后分派的偏移量之间的差异。

属性

消费者订阅的属性。

流

消费者所连接的流。

订阅ID

消费者的连接范围ID。

如果没有指定任何consumerinfoitem，则显示connection_pid、subscription_id、stream、messages_consumed、offset、offset_lag、credits、active、activity_status和properties。

例如，此命令显示每个消费者的连接PID、订阅ID和流

rabbitmq-streams list_stream_consumers connection_pid subscription_id stream

list_stream_publishers [-p vhost] [publisherinfoitem ...]

返回已注册的发布者。

publisherinfoitem参数用于指示结果中包含哪些发布者信息项。结果中的列顺序将与参数顺序匹配。publisherinfoitem可以取以下列表中的任何值

连接 PID

与消费者连接关联的 Erlang 进程的 ID。

已确认的消息数

发布者的已确认消息数。

错误消息数

发布者的错误消息数。

已发布的消息数

发布者发布的消息总数。

发布者ID

发布者的连接范围ID。

引用

发布者的去重引用。

流

发布者发布到的流。

如果没有指定任何publisherinfoitem，则显示connection_pid、publisher_id、stream、reference、messages_published、messages_confirmed和messages_errored。

例如，此命令显示每个生产者的连接PID、发布者ID和流

rabbitmq-streams list_stream_publishers connection_pid publisher_id stream

add_super_stream 超级流 [--vhost 虚拟主机] [--partitions 分区数] [--binding-keys 绑定键] [--max-length-bytes 最大长度（字节）] [--max-age 最大年龄] [--stream-max-segment-size-bytes 流最大段大小（字节）] [--leader-locator 领导者定位器] [--initial-cluster-size 初始集群大小]

超级流

要创建的超级流的名称。

虚拟主机

要创建超级流的虚拟主机的名称。

分区数

超级流将具有的分区数。

绑定键

绑定键的逗号分隔列表。

最大长度（字节）

分区流的最大大小，例如：20gb、500mb。

最大年龄

分区流段的最大年龄，使用 ISO 8601 持续时间格式，例如 PT10M30S 表示 10 分钟 30 秒，P5DT8H 表示 5 天 8 小时。

流最大段大小（字节）

分区流段的最大大小，例如：500mb、1gb。

领导者定位器

分区流的领导者定位器策略。可能的值为

• 客户端本地

• 平衡

默认值为平衡

初始集群大小

分区流的初始集群大小。

创建超级流。

delete_super_stream 超级流 [--vhost 虚拟主机]

超级流

要删除的超级流的名称。

虚拟主机

超级流的虚拟主机。

删除超级流。

list_stream_consumer_groups [-p vhost] [groupinfoitem ...]

列出虚拟主机中流单一活动消费者的组。

groupinfoitem参数用于指示结果中包含哪些组信息项。结果中的列顺序将与参数顺序匹配。groupinfoitem可以取以下列表中的任何值

消费者数量

组中的消费者数量。

分区索引

如果流是超级流的一部分，则为流分区索引，如果不是，则为 -1。

引用

组引用（名称）。

流

消费者所连接的流。

如果没有指定任何groupinfoitem，则显示stream、reference、partition_index和consumers。

例如，此命令显示每个组的流、引用和消费者数量

rabbitmq-streams list_stream_consumer_groups stream reference consumers

list_stream_group_consumers --stream stream --reference reference [--vhost vhost] [consumerinfoitem ...]

列出虚拟主机中流消费者组的消费者。

流

消费者所连接的流。

引用

组引用（名称）。

虚拟主机

流的虚拟主机。

The 消费者信息项 参数用于指示要包含在结果中的消费者信息项。结果中的列顺序将与参数的顺序匹配。消费者信息项 可以取以下列表中的任何值

连接名称

消费者的连接的可读名称。

状态

消费者状态；其中之一

• 活动

• 非活动

订阅ID

消费者的连接范围ID。

如果没有指定任何consumerinfoitem，则显示subscription_id、connection_name和state。

例如，此命令显示连接到 stream-1 流并属于 stream-1 组的每个消费者的连接名称和状态

rabbitmq-streams list_stream_group_consumers --stream stream-1 --reference stream-1 connection_name state

另请参见

rabbitmqctl(8)、rabbitmq-diagnostics(8)、rabbitmq-server(8)、rabbitmq-queues(8)、rabbitmq-upgrade(8)、rabbitmq-service(8)、rabbitmq-env.conf(5)、rabbitmq-echopid(8)

作者

RabbitMQ 团队 <contact-tanzu-data.pdl@broadcom.com>