分布式消息服务 RocketMQ 版
用户指南
文档版本 01
发布日期 2022-01-21
版权所有 © 华为技术有限公司 2022。 保留一切权利。
非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传 播。
商标声明
和其他华为商标均为华为技术有限公司的商标。
本文档提及的其他所有商标或注册商标,由各自的所有人拥有。
注意
您购买的产品、服务或特性等应受华为公司商业合同和条款的约束,本文档中描述的全部或部分产品、服务或 特性可能不在您的购买或使用范围之内。除非合同另有约定,华为公司对本文档内容不做任何明示或暗示的声 明或保证。
由于产品版本升级或其他原因,本文档内容会不定期进行更新。除非另有约定,本文档仅作为使用指导,本文 档中的所有陈述、信息和建议不构成任何明示或暗示的担保。
目 录
1 权限管理...1
1.1 创建并授权使用 DMS for RocketMQ... 1
2 准备实例依赖资源... 3
3 购买实例...5
4 连接实例...7
4.1 连接未开启 SSL 的 RocketMQ 实例... 7
4.2 连接已开启 SSL 的 RocketMQ 实例... 9
5 实例管理...11
5.1 变更实例规格...11
5.2 查看实例... 12
5.3 删除实例... 13
5.4 修改实例信息...15
5.5 设置实例公网访问... 15
5.6 按需转包周期...17
6 Topic 管理...18
6.1 创建 Topic...18
6.2 查询 Topic 信息... 19
6.3 修改 Topic 参数... 20
6.4 删除 Topic...20
7 消息查询...22
7.1 查询消息... 22
7.2 开启消息轨迹...24
8 消费组管理...25
8.1 创建消费组... 25
8.2 查询消费组信息... 26
8.3 修改消费组参数... 27
8.4 删除消费组... 28
9 用户管理...29
9.1 创建用户... 29
9.2 编辑用户... 31
用户指南 目 录
9.3 删除用户... 32
10 管理死信队列...34
11 监控... 36
11.1 支持的监控指标...36
11.2 查看监控数据... 41
12 审计... 43
12.1 支持云审计的操作列表...43
12.2 查看云审计日志...44
用户指南 目 录
1 权限管理
1.1 创建并授权使用 DMS for RocketMQ
如果您需要对您所拥有的DMS for RocketMQ进行精细的权限管理,您可以使用统一 身份认证服务(Identity and Access Management,简称IAM),通过IAM,您可 以:
● 根据企业的业务组织,在您的华为云帐号中,给企业中不同职能部门的员工创建 IAM用户,让员工拥有唯一安全凭证,并使用DMS for RocketMQ资源。
● 根据企业用户的职能,设置不同的访问权限,以达到用户之间的权限隔离。
● 将DMS for RocketMQ资源委托给更专业、高效的其他华为云帐号或者云服务,
这些帐号或者云服务可以根据权限进行代运维。
如果华为云帐号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章 节,不影响您使用DMS for RocketMQ的其它功能。
本章节为您介绍对用户授权的方法,操作流程如图1-1所示。
前提条件
给用户组授权之前,请您了解用户组可以添加的DMS for RocketMQ权限,并结合实 际需求进行选择,DMS for RocketMQ支持的系统权限,请参见:DMS for
RocketMQ系统策略。若您需要对除DMS for RocketMQ之外的其它服务授权,IAM支
持服务的所有策略请参见系统权限。用户指南 1 权限管理
示例流程
图1-1 给用户授权 DMS for RocketMQ 权限流程
1. 创建用户组并授权
在IAM控制台创建用户组,并授予DMS for RocketMQ的管理员权限“DMS Administrator”。
2. 创建用户并加入用户组
在IAM控制台创建用户,并将其加入1中创建的用户组。
3. 用户登录并验证权限
新创建的用户登录控制台,验证DMS for RocketMQ的管理员权限。
用户指南 1 权限管理
2 准备实例依赖资源
概述
在购买RocketMQ实例前,您需要提前准备相关依赖资源,包括虚拟私有云(Virtual Private Cloud,以下简称VPC)、子网和安全组,并配置安全组策略。每个RocketMQ 实例都部署在某个VPC中,并绑定具体的子网和安全组,通过这样的方式为RocketMQ 提供一个隔离的、用户自主配置和管理的虚拟网络环境以及安全保护策略,提升实例 的安全性。
准备依赖资源
RocketMQ实例所需资源的具体要求和创建指导如表2-1所示。
表2-1 RocketMQ 实例依赖资源
准备资源 要求 创建指导
VPC和子网 不同的RocketMQ实例可以重复使 用相同的VPC和子网,也可以使用 不同的VPC和子网,请根据实际需 要进行配置。在创建VPC和子网时 应注意如下要求:
● 创建的VPC与使用的分布式消息 服务RocketMQ版应在相同的区 域。
● 创建VPC和子网时,如无特殊需 求,配置参数使用默认配置即 可。
创建VPC和子网的操作指导请参 考创建虚拟私有云和子网,若需 要在已有VPC上创建和使用新的 子网,请参考为虚拟私有云创建 新的子网。
用户指南 2 准备实例依赖资源
准备资源 要求 创建指导 安全组 不同的RocketMQ实例可以重复使
用相同的安全组,也可以使用不同 的安全组,请根据实际需要进行配 置。在创建安全组时应注意如下要 求:
● 创建安全组时,“模板”选择
“自定义”。
● 创建安全组后,请保留系统默认 添加的入方向“允许安全组内的 弹性云服务器彼此通信”规则和 出方向“放通全部流量”规则。
● 使用分布式消息服务RocketMQ 版必须添加表2-2所示安全组规 则,其他规则请根据实际需要添 加。
创建安全组的操作指导请参考创 建安全组,为安全组添加规则的 操作指导请参考添加安全组规 则。
表2-2 安全组规则
方向 协议 端口 源地址 说明
入方向 TCP 8100 0.0.0.0/0 VPC内访问元数据节点的端口 入方向 TCP 8200 0.0.0.0/0 公网访问元数据节点的端口 入方向 TCP 10100-10
199 0.0.0.0/0 访问业务节点的端口
用户指南 2 准备实例依赖资源
3 购买实例
操作场景
RocketMQ实例采用物理隔离的方式部署,租户独占RocketMQ实例。支持用户自定义 规格和自定义特性,您可以根据业务需要定制相应规格和存储空间的RocketMQ实例。
前提条件
RocketMQ实例运行于虚拟私有云,购买实例前,需保证有可用的虚拟私有云,并且已 配置好安全组与子网。
购买实例
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击页面右上方的“购买RocketMQ实例”,进入“购买RocketMQ实例”页面。
步骤3 选择“计费模式”、“区域”、“项目”和“可用区”。
步骤4 设置实例信息。
1. 实例名称:实例的名称,用于区分不同的实例。
2. 版本:RocketMQ的版本号,当前仅支持4.8.0。
3. 实例类型:当前仅支持“集群”,保持默认值即可。
4. CPU架构:当前仅支持“x86计算”,保持默认值即可。
5. 规格:根据实际业务情况选择实例规格。
6. 代理个数:RocketMQ实例的代理个数。
7. 代理存储空间:选择RocketMQ实例的磁盘类型和储存空间总量。
磁盘类型支持高I/O和超高I/O,如何选择磁盘类型请参考磁盘类型及性能介绍。
8. 虚拟私有云:选择已经创建好的虚拟私有云和子网。
虚拟私有云可以为您的RocketMQ实例构建隔离的、能自主配置和管理的虚拟网络 环境。
9. 安全组:选择已经创建好的安全组。
安全组是一组对弹性云服务器的访问规则的集合,为同一个VPC内具有相同安全 保护需求并相互信任的弹性云服务器提供访问策略。
您可以单击右侧的“管理安全组”,跳转到网络控制台的“安全组”页面,查看 或创建安全组。
用户指南 3 购买实例
步骤5 设置实例购买时长。
当选择了“包年/包月”付费模式时,页面才显示“购买时长”参数,您需要根据业务 需要选择。
步骤6 单击“更多配置”,设置更多相关信息。
● 设置“公网访问”。
“公网访问”默认为关闭状态,您可以选择是否开启。开启公网访问后,还需要 为每个节点设置对应的IPv4弹性IP地址。
● 设置SSL。
客户端连接RocketMQ实例时,是否开启SSL认证。开启SSL,则数据加密传输,
安全性更高。
购买实例后,SSL开关不支持修改,请慎重选择。如果购买后需要修改,需要重新 购买实例。
● 设置标签。
标签用于标识云资源,当您拥有相同类型的许多云资源时,可以使用标签按各种 维度(例如用途、所有者或环境)对云资源进行分类。
– 如果您已经预定义了标签,在“标签键”和“标签值”中选择已经定义的标 签键值对。另外,您可以单击右侧的“查看预定义标签”,跳转到标签管理 服务页面,查看已经预定义的标签,或者创建新的标签。
– 您也可以直接在“标签键”和“标签值”中设置标签。
当前每个RocketMQ实例最多支持设置20个不同标签。
● 设置实例的描述信息。
步骤7 填写完上述信息后,单击“立即购买”,进入规格确认页面。
步骤8 确认实例信息无误且阅读并同意《华为云用户协议》后,如果“计费模式”选择“包 年/包月”,单击“去支付”。根据界面提示信息,支付费用。如果“计费模式”选择
“按需付费”,单击“提交”。
步骤9 在实例列表页面查看实例是否创建成功。
创建实例大约需要3到15分钟,此时实例的“状态”为“创建中”。
● 当实例的“状态”变为“运行中”时,说明实例创建成功。
● 如果创建实例失败,在信息栏的“创建失败任务”中查看创建失败的实例。请参 考删除实例,删除创建失败的实例,然后重新创建。如果重新创建仍然失败,请 联系客服。
----结束
用户指南 3 购买实例
4 连接实例
4.1 连接未开启 SSL 的 RocketMQ 实例
本文主要介绍在命令行模式下不使用SSL连接RocketMQ实例的操作,其中包含VPC内 和公网环境下两种连接场景。
在不使用SSL连接的场景下,通过VPC内访问和通过公网环境访问,仅涉及连接IP和端 口不一致,其他操作步骤是一样的。VPC内访问的连接端口为8100,公网环境下访问 的连接端口为8200。
文中仅介绍公网环境下的连接示例,在VPC内连接时,替换为相应的连接地址即可。
前提条件
● 已创建RocketMQ实例,并记录实例详情中的“元数据连接地址”(VPC内访 问)/“元数据公网连接地址”(公网访问)。
● 已配置安全组。
● 已创建Topic。
● 已创建弹性云服务器,并且弹性云服务器的VPC、子网、安全组与RocketMQ实例 的VPC、子网、安全组保持一致。
● 已安装Java Development Kit 1.8.111或以上版本,并完成环境变量配置。
命令行模式连接实例
步骤1 下载“rocketmq-tutorial”示例软件包。
wget https://dms-demo.obs.cn-north-1.myhuaweicloud.com/rocketmq-tutorial.zip
步骤2 解压“rocketmq-tutorial”。
unzip rocketmq-tutorial.zip
步骤3 进入“rocketmq-tutorial/bin”目录。
cd rocketmq-tutorial/bin
步骤4 运行生产普通消息示例。
sh mqadmin sendMessage -n "${连接地址}" -t ${Topic名称} -p "hello rocketmq"
参数说明如下:
用户指南 4 连接实例
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
sh mqadmin sendMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test -p "hello rocketmq"
使用Ctrl+C命令退出。
步骤5 运行消费普通消息示例。
sh mqadmin consumeMessage -n "${连接地址}" -t ${Topic名称}
参数说明如下:
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
sh mqadmin consumeMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test
如需停止消费使用Ctrl+C命令退出。
步骤6 运行生产带消息轨迹的消息示例。
sh mqadmin sendMessage -n "${连接地址}" -t ${Topic名称} -p "hello rocketmq" -m true
参数说明如下:
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
sh mqadmin sendMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test -p "hello rocketmq" - m true
使用Ctrl+C命令退出。
步骤7 运行消费消息示例,并发送消息轨迹。
sh mqadmin consumeMessage -n "${连接地址}" -t ${Topic名称} -m true
参数说明如下:
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
sh mqadmin consumeMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test -m true
使用Ctrl+C命令退出。
----结束
用户指南 4 连接实例
4.2 连接已开启 SSL 的 RocketMQ 实例
本文主要介绍在命令行模式下使用SSL连接RocketMQ实例的操作,其中包含VPC内和 公网环境下两种连接场景。
在使用SSL连接的场景下,通过VPC内访问和通过公网环境访问,仅涉及连接IP和端口 不一致,其他操作步骤是一样的,VPC内访问的连接端口为8100,公网环境下访问的 连接端口为8200。
文中仅介绍公网环境下的连接示例,在VPC内连接时,替换为相应的连接地址即可。
前提条件
● 已创建RocketMQ实例,并记录实例详情中的“元数据连接地址”(VPC内访 问)/“元数据公网连接地址”(公网访问)。
● 已配置安全组。
● 已创建Topic。
● 已创建弹性云服务器,并且弹性云服务器的VPC、子网、安全组与RocketMQ实例 的VPC、子网、安全组保持一致。
● 已安装Java Development Kit 1.8.111或以上版本,并完成环境变量配置。
命令行模式连接实例
步骤1 下载“rocketmq-tutorial”示例软件包。
wget https://dms-demo.obs.cn-north-1.myhuaweicloud.com/rocketmq-tutorial.zip
步骤2 解压“rocketmq-tutorial”。
unzip rocketmq-tutorial.zip
步骤3 进入“rocketmq-tutorial/bin”目录。
cd rocketmq-tutorial/bin
步骤4 运行生产普通消息示例。
JAVA_OPT=-Dtls.enable=true sh mqadmin sendMessage -n "${连接地址}" -t ${Topic名称} -p "hello rocketmq"
参数说明如下:
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
JAVA_OPT=-Dtls.enable=true sh mqadmin sendMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test -p "hello rocketmq"
使用Ctrl+C命令退出。
步骤5 运行消费普通消息示例。
JAVA_OPT=-Dtls.enable=true sh mqadmin consumeMessage -n "${连接地址}" -t ${Topic名称}
参数说明如下:
用户指南 4 连接实例
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
JAVA_OPT=-Dtls.enable=true sh mqadmin consumeMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test
如需停止消费使用Ctrl+C命令退出。
步骤6 运行生产带消息轨迹的消息示例。
JAVA_OPT=-Dtls.enable=true sh mqadmin sendMessage -n "${连接地址}" -t ${Topic名称} -p "hello rocketmq" -m true
参数说明如下:
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
JAVA_OPT=-Dtls.enable=true sh mqadmin sendMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test -p "hello rocketmq" -m true
使用Ctrl+C命令退出。
步骤7 运行消费消息示例,并发送消息轨迹。
JAVA_OPT=-Dtls.enable=true sh mqadmin consumeMessage -n "${连接地址}" -t ${Topic名称} -m true
参数说明如下:
● 连接地址:表示RocketMQ实例的元数据连接地址(VPC内访问)/元数据公网连 接地址(公网访问)。
● Topic名称:RocketMQ实例下创建的Topic名称。
示例如下,其中“100.85.125.89:8200;100.85.119.144:8200”为RocketMQ实例的元 数据公网连接地址,“topic-test”为Topic名称。
JAVA_OPT=-Dtls.enable=true sh mqadmin consumeMessage -n "100.85.125.89:8200;100.85.119.144:8200" -t topic-test -m true
使用Ctrl+C命令退出。
----结束
用户指南 4 连接实例
5 实例管理
5.1 变更实例规格
操作场景
RocketMQ实例创建成功后,您可以根据业务需要,扩容存储空间和代理个数。不支持 同时扩容存储空间和代理个数,如果需要可以分别进行扩容。
当前只支持扩容,不支持缩容。扩容存储空间有次数限制,只能扩容20次。扩容代理 个数,可以扩大总分区数。
前提条件
已创建RocketMQ实例,且实例状态为“运行中”。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 通过以下任意一种方法,变更实例规格。
● 在待变更规格的实例所在行,单击“更多 > 变更规格”。
● 单击RocketMQ实例名称,进入实例详情页面。单击右上角的“更多 > 变更规 格”。
步骤3 根据实际情况选择扩容存储空间或者代理个数。
不支持同时扩容存储空间和代理个数,如果需要可以分别进行扩容。
● 扩容存储空间。
在“变更方式”中,选择“存储扩容”,在“单个代理存储空间”中,选择扩容 后的单个代理的存储空间大小,单击“下一步”。确认扩容信息无误后,单击
“提交”。
在实例列表页面的“可用存储空间”中查看扩容后的总存储空间大小(即扩容后 的单个代理的存储空间*代理个数)。
用户指南 5 实例管理
说明
– 扩容存储空间不会影响业务。
– 可用存储空间=实际存储空间-用于存储日志和ZK的数据的存储空间-格式化磁盘的损 耗。
例如,实际扩容存储空间到700GB,用于存储日志和ZK的数据的存储空间为100GB,
格式化磁盘损耗7GB,那么扩容后的可用存储空间为593GB。
● 扩容代理个数。
在“变更方式”中,选择“代理扩容”,在“代理个数”中,选择扩容后的代理 个数,单击“下一步”。确认扩容信息无误后,单击“提交”。
在实例列表页面的“规格”中查看扩容后的代理个数。
说明
– 扩容代理个数不会影响原来的代理,业务也不受影响。
– 新创建的Topic才有可能创建在新代理上,原来Topic还分布在原有代理上,如果需要使 用新扩容的代理,可以通过新建Topic来实现。
– 已开启公网访问,且设置了弹性IP地址的实例,在扩容代理个数时,需要为新扩容的代 理设置弹性IP地址。
----结束
5.2 查看实例
操作场景
本节介绍如何在分布式消息服务RocketMQ版控制台查看RocketMQ实例的详细信息。
例如,连接RocketMQ实例时,需要获取的连接IP地址和端口号。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 RocketMQ实例支持通过筛选来查询对应的RocketMQ实例。当前支持的筛选条件为
“状态”、“名称”和“ID”。RocketMQ实例状态请参见表5-1。
表5-1 RocketMQ 实例状态说明
状态 说明
创建中 创建RocketMQ实例后,在RocketMQ实例状态进入运行中之前的状 态。
创建失败 RocketMQ实例处于创建异常状态。
运行中 RocketMQ实例正常运行状态。
故障 RocketMQ实例处于故障状态。
启动中 实例从已冻结到运行中的中间状态。
已冻结 实例处于已冻结状态。
用户指南 5 实例管理
状态 说明
冻结中 实例从运行中到已冻结的中间状态。
步骤3 单击RocketMQ实例的名称,进入该RocketMQ实例的基本信息页面,查看RocketMQ 实例的详细信息。
表5-2为连接实例的相关参数,其他参数,请查看页面显示
表5-2 实例参数
参数 说明
元数据连接地 址
未开启公网访问时,实例元数据管理节点的地址,大部分场景下 客户端只需要配置此地址即可。
业务连接地址 未开启公网访问时,实例业务处理节点的地址,当需要对单一业 务节点进行操作时,可以使用其中某一地址。
公网访问 公网访问状态。单击“公网访问”后的 ,开启/关闭公网访问。
元数据公网连 接地址
仅开启公网访问后可见。
开启公网访问后,实例元数据管理节点的地址,大部分场景下客 户端只需要配置此地址即可。
业务公网连接 地址
仅开启公网访问后可见。
开启公网访问后,实例业务处理节点的地址。
SSL 实例的SSL状态。
ACL访问控制
实例的ACL访问状态。单击“ACL访问控制”后的 ,开启 ACL访问。
说明仅2021年8月21号后购买的实例,支持设置此参数。
----结束
5.3 删除实例
操作场景
分布式消息服务RocketMQ版控制台支持删除RocketMQ实例,且可实现批量删除 RocketMQ实例、一键式删除创建失败的RocketMQ实例。
须知
RocketMQ实例删除后,实例中原有的数据将被删除,且没有备份,请谨慎操作。
用户指南 5 实例管理
前提条件
RocketMQ实例状态为运行中、故障时,才能执行删除操作。
删除 RocketMQ 实例
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 选择以下任意一种方法删除实例。
● 在待删除的RocketMQ实例所在行,单击“更多 > 删除”。
● 单击待删除的RocketMQ实例名称,进入实例详情页面。在页面右上角,单击“更 多 > 删除”。
● 如需批量删除实例,勾选待删除的实例,单击“删除”。
说明
RocketMQ实例状态为创建中、重启中时不允许执行删除操作。
步骤3 单击“确定”,完成删除RocketMQ实例。
删除RocketMQ实例大约需要1到60秒。
----结束
删除创建失败的 RocketMQ 实例
步骤1 登录分布式消息服务RocketMQ版控制台。
如果当前存在创建失败的RocketMQ实例,信息栏会显示“创建失败任务”及失败数 量。
图5-1 创建失败任务
步骤2 单击“创建失败任务”后的图标或者数量,弹出“创建失败任务”对话框。
步骤3 选择以下任意一种方法,删除创建失败的RocketMQ实例。
● 单击“清理失败任务”,一键式删除所有创建失败的RocketMQ实例。
● 在需要删除的创建失败的RocketMQ实例所在行,单击“删除任务”,删除创建失 败的RocketMQ实例。
----结束
用户指南 5 实例管理
5.4 修改实例信息
操作场景
购买RocketMQ实例成功后,您可以根据自己的业务情况对RocketMQ实例的部分参数 进行调整,包括实例名称、描述和安全组。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 以下参数支持修改。
● 实例名称
● 描述
● 公网访问(公网访问的修改方法,请参考设置实例公网访问。)
● 安全组
● ACL访问控制(2021年8月21号后购买的实例,才支持修改)
参数修改完成后,通过以下方式查看修改结果。
● 修改“公网访问”,系统跳转到“后台任务管理”页签,并显示当前任务的操作 进度和结果。
● 修改“实例名称”、“描述”、“ACL访问控制”和“安全组”后,右上角直接 提示修改结果。
----结束
5.5 设置实例公网访问
您需要通过公网地址访问RocketMQ实例时,开启实例的公网访问功能,并设置弹性IP 地址。当业务不再使用公网访问功能时,关闭实例的公网访问功能。
前提条件
只有处于“运行中”状态的RocketMQ实例支持修改公网访问配置。
开启公网访问
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在“公网访问”后,单击 。
步骤4 开启 ,在“弹性IP地址”中为每个节点设置对应的IP地址,单击 ,开启公网访 问。
用户指南 5 实例管理
说明
RocketMQ实例只支持绑定IPv4弹性IP地址。
图5-2 开启公网访问
公网访问开启后,页面显示“元数据公网连接地址”和“业务公网连接地址”。
图5-3 公网连接地址
开启公网访问后,需要修改对应的安全组规则,才能成功连接RocketMQ实例。
表5-3 安全组规则
方向 协议 端口 源地址 说明
入方向 TCP 8200 0.0.0.0/0 公网访问元数据节点的端口 入方向 TCP 10100-10
199 0.0.0.0/0 访问业务节点的端口
----结束
用户指南 5 实例管理
关闭公网访问
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在“公网访问”后,单击 。
步骤4 关闭 ,单击 ,关闭公网访问。
关闭公网访问后,需要修改对应的安全组规则,才能成功连接RocketMQ实例。
表5-4 安全组规则
方向 协议 端口 源地址 说明
入方向 TCP 8100 0.0.0.0/0 VPC内访问元数据节点的端口 入方向 TCP 10100-10
199 0.0.0.0/0 访问业务节点的端口
----结束
5.6 按需转包周期
选择按需付费的用户,可以选择“转包周期”,变更实例计费模式为包年/包月。
须知
公测实例与商用实例存在差距,公测实例不推荐用于商用业务,公测实例不支持转包 周期,建议已有公测实例的用户删除公测实例,购买新的商用实例。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 通过以下任意一种方法,实现按需实例转包周期。
● 如果需要批量转包周期,勾选多个相同状态的实例,单击信息栏左上侧的“转包 周期”。
● 在待转包周期的RocketMQ实例所在行,单击“转包周期”。
● 单击RocketMQ实例名称,进入实例详情页面。单击右上角的“转包周期”。
步骤3 选择续费时长,单击“去支付”,根据界面提示信息,支付费用,完成实例转包周期 操作。
----结束
用户指南 5 实例管理
6 Topic 管理
6.1 创建 Topic
操作场景
Topic,即消息主题,消息发送与接收的基本单元。购买RocketMQ实例成功后,需要 手动创建Topic,然后才能进行生产消息和消费消息。
前提条件
已购买RocketMQ实例。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“Topic管理”,进入“Topic管理”页面。
步骤4 单击“创建Topic”,弹出“创建Topic”页面。
步骤5 参考表6-1,填写Topic名称和配置信息。
表6-1 Topic 参数说明
参数 说明
Topic名称 您可以自定义Topic名称,用于区分不同的Topic。
Topic名称不能设置为相同,否则会创建失败。
创建Topic后不能修改名称。
关联代理 选择在某个或者某几个代理上创建Topic。
创建Topic后不能修改关联代理。
用户指南 6 Topic 管理
参数 说明
队列个数 Topic的队列数,队列分为写队列和读队列。队列数越大消费的 并发度越大。
队列个数不能小于关联代理数。
权限 Topic的权限,包括发布+订阅、发布和订阅。
步骤6 配置完成后,单击“确定”,完成Topic的创建。
----结束
6.2 查询 Topic 信息
操作场景
Topic创建成功后,查询Topic相关的配置和状态信息。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“Topic管理”,进入“Topic管理”页面。
步骤4 单击需要查询的Topic名称,进入Topic详情页面。
在详情页上方可以查看Topic名称、关联代理、读队列个数、写队列个数和权限。
在详情页下方可以查看Topic在每个代理上的队列状态,包括队列ID、最小偏移量、最 大偏移量和消息更新时间。还可以查看消费组消费此Topic的情况,包括消费组名称、
最大重试次数、从头消费和广播消费。
图6-1 Topic 详情
----结束
用户指南 6 Topic 管理
6.3 修改 Topic 参数
操作场景
Topic创建成功后,您可以根据业务需要修改以下参数:读队列个数、写队列个数、权 限。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“Topic管理”,进入“Topic管理”页面。
步骤4 选择以下任意一种方法修改Topic参数。
● 在待修改的Topic所在行,单击“编辑”,弹出“编辑Topic”页面。
● 单击待修改的Topic名称,进入Topic详情页面。在页面右上角,单击“编辑”,弹 出“编辑Topic”页面。
步骤5 修改如表6-2所示配置信息。
表6-2 Topic 参数说明
参数 说明
读队列个数 Topic读数据可用的总队列数。
读队列个数不能小于关联代理数。
写队列个数 Topic写数据可用的总队列数。
写队列个数不能小于关联代理数。
权限 Topic的权限,包括发布+订阅、发布和订阅。
步骤6 修改完成后,单击“确定”。
----结束
6.4 删除 Topic
操作场景
Topic无需继续使用,需要清理时,参考本章节删除Topic。
前提条件
仅在实例的“状态”为“运行中”时,才可以删除实例中的Topic。
用户指南 6 Topic 管理
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“Topic管理”,进入“Topic管理”页面。
步骤4 选择以下任意一种方法删除Topic。
● 在待删除的Topic所在行,单击“删除”。
● 单击待删除的Topic名称,进入Topic详情页面。在页面右上角,单击“删除”。
● 如需批量删除Topic,勾选待删除的Topic,单击“删除Topic”。
须知
删除Topic会导致消息丢失,请谨慎操作。
步骤5 单击“是”,确认删除Topic。
----结束
用户指南 6 Topic 管理
7 消息查询
7.1 查询消息
操作场景
本章节指导您通过查询消息功能查看具体的消息内容,以及确定消息是否生产/消费成 功。
分布式消息服务RocketMQ版提供两种消息查询的方法:按Topic查询和按Message ID 查询。
● 按Topic查询:查询某时间段内指定Topic下所有的消息。此方法属于范围查询,查 询到的消息可能比较多。
● 按Message ID查询:查询指定Message ID的消息。此方法属于精确查找,可以快 速查询到某一条消息。
说明
公测实例不支持查询消息轨迹。
前提条件
● 已创建RocketMQ实例和Topic。
● 如果通过按Message ID查询,需要提前获取消息所在的Topic名称和消息的 Message ID。
● 查询消息轨迹前,请先开启消息轨迹。
查询消息内容
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“消息查询”,进入“消息查询”页面。
步骤4 选择以下任意一种方法,查询消息。
● 按Topic查询:“Topic”选择待查询消息的Topic名称,“存储时间”选择待查询 消息的时间段,单击“查询”。
用户指南 7 消息查询
● 按Message ID查询:“Topic”选择待查询消息所在的Topic名称,“消息ID”输 入待查询消息的Message ID,单击“查询”。
步骤5 在待查询消息所在行,单击“查看详情”,查看消息的具体内容。
----结束
查询消息轨迹
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“消息查询”,进入“消息查询”页面。
步骤4 选择以下任意一种方法,查询消息。
● 按Topic查询:“Topic”选择待查询消息的Topic名称,“存储时间”选择待查询 消息的时间段,单击“查询”。
● 按Message ID查询:“Topic”选择待查询消息所在的Topic名称,“消息ID”输 入待查询消息的Message ID,单击“查询”。
步骤5 在待查询消息所在行,单击“消息轨迹”,查看消息的轨迹,确定是否生产/消费成 功。
消息轨迹的参数说明如表7-1所示。
表7-1 消息轨迹的参数说明
参数 参数说明
生产者状态 生产者状态如下:
● 发送成功:消息发送成功,服务端已经成功存储消息。
● 提交成功:允许消费者消费此事务消息。
● 回滚:事务消息将被丢弃,不允许消费者消费此事务消 息。
● 未知,待确认:事务消息状态暂时无法确定,等待固定时 间后,服务端向生产者进行消息回查。
生产耗时 生产者发送消息的耗时。
生产地址 生产者的IP地址和端口号。
消费者状态 消费者状态如下:
● 消费成功
● 消费超时
● 消费异常
● 消费返回NULL
● 消费失败
消费时间 消费消息的时间。
消费耗时 消费者消费消息的耗时。
用户指南 7 消息查询
参数 参数说明
消费地址 消费者的IP地址和端口号。
----结束
7.2 开启消息轨迹
操作场景
查询消息轨迹前,需要先在客户端开启消息轨迹。
操作步骤
在客户端开启消息轨迹的方法如下:
● 生产者开启消息轨迹(除事务消息以外的消息类型)
构造函数的“enableMsgTrace”参数传入“true”,例如:
DefaultMQProducer producer = new DefaultMQProducer("ProducerGroupName", true);
● 生产者开启消息轨迹(事务消息)
构造函数的“enableMsgTrace”参数传入“true”,例如:
TransactionMQProducer producer = new TransactionMQProducer(null, "ProducerGroupName", null, true, null);
须知
生产者客户端版本在4.9.0以上才支持事务消息的轨迹,如果版本不满足要求,请 先升级。
● 消费者开启消息轨迹
构造函数的“enableMsgTrace”参数传入“true”,例如:
DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("ConsumerGroupName", true);
用户指南 7 消息查询
8 消费组管理
8.1 创建消费组
操作场景
消费组,即一组具有相同行为的消费者集合,用于管理和维护消息的消费状态。消费 消息前,必须创建消费组,创建步骤请参考本章节。
前提条件
已购买RocketMQ实例。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“消费组管理”,进入“消费组管理”页面。
步骤4 单击“创建消费组”,弹出“创建消费组”页面。
步骤5 参考表8-1,填写消费组名称和配置信息。
表8-1 消费组参数说明
参数 说明
消费组名称 您可以自定义消费组名称,用于区别不同的消费行为。
创建消费组后不能修改名称。
关联代理 选择在某个或者某几个代理上创建消费组。
创建消费组后不能修改关联代理。
最大重试次数 设置消费失败的最大重试次数。
用户指南 8 消费组管理
参数 说明
从头消费 设置消费组的消费策略是否为从头消费。
若开启从头消费,在客户端首次消费或消费位置失效时,会从首 条消息重新消费。否则,会从最末尾的消息开始消费。
广播消费 是否设置为广播消费。
若开启广播消费,每条消息都会被消费组内的所有消费者消费一 次。否则,每条消息只会被消费组内的某一消费者消费。
步骤6 配置完成后,单击“确定”,完成消费组的创建。
----结束
8.2 查询消费组信息
操作场景
消费组创建成功后,查询消费组相关的配置和状态信息。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“消费组管理”,进入“消费组管理”页面。
步骤4 单击需要查询的消费组名称,进入消费组详情页面。
在详情页上方可以查看消费组名称、关联代理、最大重试次数、从头消费和广播消费 的配置。
在详情页下方可以查看到消费组消费的所有Topic以及消费进度等。
用户指南 8 消费组管理
图8-1 消费组详情
----结束
8.3 修改消费组参数
操作场景
消费组创建成功后,您可以根据业务需要修改以下参数:最大重试次数、从头消费、
广播消费。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“消费组管理”,进入“消费组管理”页面。
步骤4 选择以下任意一种方法修改消费组参数。
● 在待修改的消费组所在行,单击“编辑”,弹出“编辑消费组”页面。
● 单击待修改的消费组名称,进入消费组详情页面。在页面右上角,单击“编 辑”,弹出“编辑消费组”页面。
步骤5 修改如表8-2所示配置信息。
表8-2 消费组参数说明
参数 说明
最大重试次数 设置消费失败的最大重试次数。
从头消费 设置消费组的消费策略是否为从头消费。
若开启从头消费,在客户端首次消费或消费位置失效时,会从首 条消息重新消费。否则,会从最末尾的消息开始消费。
用户指南 8 消费组管理
参数 说明
广播消费 是否设置为广播消费。
若开启广播消费,每条消息都会被消费组内的所有消费者消费一 次。否则,每条消息只会被消费组内的某一消费者消费。
步骤6 修改完成后,单击“确定”。
----结束
8.4 删除消费组
操作场景
消费组无需继续使用,需要清理时,参考本章节删除消费组。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“消费组管理”,进入“消费组管理”页面。
步骤4 选择以下任意一种方法删除消费组。
● 在待删除的消费组所在行,单击“删除”。
● 单击待删除的消费组名称,进入消费组详情页面。在页面右上角,单击“删 除”。
● 如需批量删除消费组,勾选待删除的消费组,单击“删除消费组”。
步骤5 单击“是”,确认删除消费组。
----结束
用户指南 8 消费组管理
9 用户管理
9.1 创建用户
操作场景
RocketMQ实例支持ACL权限控制功能,通过创建多个用户并为其赋予不同的Topic和 消费组权限,以达到用户之间的权限隔离。
前提条件
已购买RocketMQ实例。
步骤一:开启 ACL 访问控制
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在“连接信息”区域,单击“ACL访问控制”后的 ,开启ACL访问控制。
图9-1 开启 ACL 访问控制
用户指南 9 用户管理
须知
● 仅2021年8月21号后购买的实例,支持设置ACL访问控制。
● 开启ACL访问控制会导致没有配置认证信息的客户端连接中断。
----结束
步骤二:创建用户
步骤1 在左侧导航栏,单击“用户管理”,进入“用户管理”页面。
步骤2 单击“创建用户”,弹出“创建用户”对话框。
步骤3 参考表9-1,填写用户名称和配置信息。
表9-1 用户参数说明
参数 说明
名称 自定义用户名称,用于识别不同的用户。
用户名创建成功后,不可修改。
IP白名单 如果请求的来源IP为IP白名单中的地址,不需要校验用户密钥 是否正确,且具有所有Topic和消费组的发布+订阅权限。
IP白名单可以配置为具体的IP地址,也可以配置为网段。如:
192.168.1.2,192.168.2.3或者192.*.*.*
管理员 开启管理员时,具有所有Topic和消费组的发布+订阅权限。
默认Topic权限 默认的Topic权限。
如果为指定Topic设置特殊权限,特殊权限会覆盖默认权限,
此Topic的实际权限为特殊权限。例如:默认权限为订阅,指 定Topic的特殊权限为发布+订阅,则此Topic实际权限为发布 +订阅。
默认消费组权限 默认的消费组权限。
如果为指定消费组设置特殊权限,特殊权限会覆盖默认权 限,此消费组的实际权限为特殊权限。例如:默认权限为订 阅,指定消费组的权限为发布+订阅,则此消费组实际权限为 发布+订阅。
密钥 设置用户的密钥。
步骤4 单击“确定”,完成用户的创建。
----结束
(可选)步骤三:为指定 Topic/消费组设置特殊权限
步骤1 单击用户名称,进入用户详情页面。
步骤2 在“Topic权限”/“消费组权限”页签中,单击添加权限,弹出“添加权限”对话框。
用户指南 9 用户管理
步骤3 勾选需要添加权限的Topic或者消费组,选择所需的特殊权限,单击“确定”。
指定Topic或者消费组的特殊权限会覆盖默认权限,如图9-2中,test01的实际权限为发 布+订阅。
图9-2 用户详情页面
----结束
步骤四:通过用户访问服务端
实例开启ACL访问控制后,消息生产者和消费者都需要增加用户认证信息,具体操作如 下:
● 生产者初始化时需要增加“rpcHook”参数。
RPCHook rpcHook = new AclClientRPCHook(new SessionCredentials(ACL_ACCESS_KEY, ACL_SECRET_KEY));
DefaultMQProducer producer = new DefaultMQProducer("ProducerGroupName", rpcHook);
ACL_ACCESS_KEY为用户名,ACL_SECRET_KEY为用户的密钥。
● 消费者初始化时需要增加“rpcHook”参数。
RPCHook rpcHook = new AclClientRPCHook(new SessionCredentials(ACL_ACCESS_KEY, ACL_SECRET_KEY));
DefaultMQPushConsumer consumer = new DefaultMQPushConsumer(null, "ConsumerGroupName", rpcHook);
ACL_ACCESS_KEY为用户名,ACL_SECRET_KEY为用户的密钥。
9.2 编辑用户
操作场景
用户创建成功后,您可以根据业务需要修改以下用户信息:IP白名单、管理员、默认 Topic权限、默认消费组权限和密钥。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“用户管理”,进入“用户管理”页面。
步骤4 在待修改的用户所在行,单击“编辑”,弹出“编辑用户”对话框。
步骤5 根据业务需要,修改如表9-2所示信息。
用户指南 9 用户管理
表9-2 用户参数说明
参数 说明
IP白名单 如果请求的来源IP为IP白名单中的地址,不需要校验用户密钥 是否正确,且具有所有Topic和消费组的发布+订阅权限。
IP白名单可以配置为具体的IP地址,也可以配置为网段。如:
192.168.1.2,192.168.2.3或者192.*.*.*
管理员 开启管理员时,具有所有Topic和消费组的发布+订阅权限。
默认Topic权限 默认的Topic权限。
如果为指定Topic设置特殊权限,特殊权限会覆盖默认权限,
此Topic的实际权限为特殊权限。例如:默认权限为订阅,指 定Topic的特殊权限为发布+订阅,则此Topic实际权限为发布 +订阅。
默认消费组权限 默认的消费组权限。
如果为指定消费组设置特殊权限,特殊权限会覆盖默认权 限,此消费组的实际权限为特殊权限。例如:默认权限为订 阅,指定消费组的权限为发布+订阅,则此消费组实际权限为 发布+订阅。
密钥 设置用户的密钥。
步骤6 单击“确定”,完成用户的修改。
----结束
9.3 删除用户
操作场景
用户无需继续使用,需要清理时,参考本章节删除用户。
须知
删除用户后会删除授权关系,原来使用该用户认证的请求将无法访问。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“用户管理”,进入“用户管理”页面。
步骤4 在待删除的用户所在行,单击“删除”,弹出“删除用户”对话框。
用户指南 9 用户管理
步骤5 单击“是”,完成用户的删除。
----结束
用户指南 9 用户管理
10 管理死信队列
操作场景
死信队列用于处理无法被正常消费的消息。
一条消息初次消费失败会被重试消费,若重试次数达到最大值(默认16次,在客户端 可配置)时,依然消费失败,则其将被发送到该消费者对应的特殊队列(即死信队 列)中,这种消息被称为死信消息。
本章节主要介绍如何查询和导出死信消息。
分布式消息服务RocketMQ版提供两种死信消息查询的方法:按Group查询和按 Message ID查询。
● 按Group查询:查询某时间段内指定消费组下所有的死信消息。此方法属于范围 查询,查询到的死信消息可能比较多。
● 按Message ID查询:查询指定Message ID的消息。此方法属于精确查找,可以快 速查询到某一条死信消息。
前提条件
● 已创建RocketMQ实例和消费组。
● 如果通过按Message ID查询,需要提前获取消息所在的消费组名称和消息的 Message ID。
查询死信消息
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“死信队列”,进入“死信队列”页面。
步骤4 选择以下任意一种方法,查询死信消息。
● 按Group查询:“Group”选择待查询消费组的名称,“存储时间”选择待查询死 信消息的时间段,单击“查询”。
● 按Message ID查询:“Group”选择待查询消费组的名称,“Message ID”输入 待查询死信消息的Message ID,单击“查询”。
----结束
用户指南 10 管理死信队列
导出死信消息
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 单击RocketMQ实例的名称,进入实例详情页面。
步骤3 在左侧导航栏,单击“死信队列”,进入“死信队列”页面。
步骤4 在待导出的死信消息所在行,单击“导出消息”。
导出json格式的文件。
说明
如果需要批量导出死信消息,勾选待导出的多条死信消息,单击“批量导出消息”。
----结束
用户指南 10 管理死信队列
11 监控
11.1 支持的监控指标
功能说明
本章节定义了分布式消息服务RocketMQ版上报云监控服务的监控指标的命名空间,监 控指标列表和维度定义,您可以通过分布式消息服务RocketMQ版控制台来检索分布式 消息服务RocketMQ版产生的监控指标和告警信息。
命名空间
SYS.DMS
实例监控指标
表11-1 RocketMQ 实例支持的监控项
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
instance_pro
duce_msg 消息生产 数
实例一分钟收 到的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _instance_i d
1分钟
用户指南 11 监控
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
instance_con
sume_msg 消息消费 数
实例一分钟被 消费的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _instance_i d
1分钟
节点指标监控
表11-2 节点支持的监控项
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
broker_produ
ce_msg 消息生产 数
节点一分钟收 到的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_consu
me_msg 消息消费 数
节点一分钟被 消费的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_produ
ce_rate 消息生产 速率
节点每秒收到 的消息数 单位:Count/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_consu
me_rate 消息消费 速率
节点每秒被消 费的消息数 单位:Count/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
用户指南 11 监控
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
broker_total_
bytes_in_rate 网络入流 量
节点每秒网络 访问流入流量 单位:Byte/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_total_
bytes_out_ra te
网络出流 量
节点每秒网络 访问流出流量 单位:Byte/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_cpu_c
ore_load CPU核均 负载
该指标用于统 计节点虚拟机 CPU每个核的平 均负载
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_disk_
usage 磁盘容量 使用率
该指标用于统 计节点虚拟机 的磁盘容量使 用率
单位:%
0~100 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
broker_mem
ory_usage 内存使用 率
该指标用于统 计节点虚拟机 的内存使用率 单位:%
0~100 测量对象:
分布式消息 服务 测量维度:
reliablemq _broker
1分钟
用户指南 11 监控
Topic 监控指标
表11-3 Topic 支持的监控项
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
topic_produc
e_msg 消息生产
数 Topic一分钟收 到的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _topics
1分钟
topic_consu
me_msg 消息消费 数
Topic一分钟被 消费的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _topics
1分钟
topic_produc
e_rate 消息生产
速率 Topic每秒收到 的消息数 单位:Count/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _topics
1分钟
topic_consu
me_rate 消息消费 速率
Topic每秒被消 费的消息数 单位:Count/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _topics
1分钟
消费组监控指标
表11-4 消费组支持的监控项
指标ID 指标名称 含义 取值范
围
测量对象&
维度
监控周期
(原始指 标)
group_consu
me_msg 消费组消 息消费数
消费组一分钟 消费的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _groups
1分钟
用户指南 11 监控
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
group_accum
ulation 消费组可 消费消息 数
消费组的消息 堆积量 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _groups
1分钟
group_topic_
consume_ms g
Topic消息 消费数
消费组对指定 Topic一分钟消 费的消息数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _groups_to pics
1分钟
group_topic_
consume_rat e
Topic消费 速率
消费组对指定 Topic每秒消费 的消息数 单位:Count/s
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _groups_to pics
1分钟
group_topic_
accumulatio n
Topic可消 费消息数
消费组对指定 Topic的消息堆 积数
单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _groups_to pics
1分钟
死信队列监控指标
指标ID 指标名称 含义 取值范
围 测量对象&
维度
监控周期
(原始指 标)
dlq_accumul
ation 死信Topic
消息量 死信Topic的消 息量总数 单位:Count
>0 测量对象:
分布式消息 服务 测量维度:
reliablemq _dlq_topics
1分钟
用户指南 11 监控
11.2 查看监控数据
操作场景
云监控对RocketMQ实例的运行状态进行日常监控,可以通过控制台直观的查看 RocketMQ实例各项监控指标。
前提条件
已购买RocketMQ实例。
操作步骤
步骤1 登录分布式消息服务RocketMQ版控制台。
步骤2 选择以下任意一种方法查看监控数据。
● 在待查看监控数据的实例所在行,单击 。
● 单击RocketMQ实例的名称,进入实例详情页面。在左侧导航栏,单击“实例监 控”。
步骤3 在“实例监控”页面,查看实例、节点、主题、消费组和死信队列的监控数据。
聚合是指云监控服务在一定周期内对原始采样指标数据进行最大、最小、平均、求和 或方差值的计算,并把结果持久化的过程。这个计算周期又叫聚合周期。
步骤4 (可选)在监控页面,您可以自行选择哪些监控指标需要展示,以及对监控指标进行 排序。
例如,在“节点”页签中,只需要展示“消息生产数”和“消息消费数”,请按照如 下步骤操作。
1. 在“节点”页签下,单击“设置”,弹出“设置”页面。
2. 勾选“消息生产数”和“消息消费数”,单击“确定”。
用户指南 11 监控
图11-1 设置监控指标
3. 监控指标设置成功后,选中监控指标,并拖动到需要展示的位置,完成监控指标 的排序。
----结束
用户指南 11 监控
12 审计
12.1 支持云审计的操作列表
通过云审计服务,您可以记录与分布式消息服务RocketMQ版相关的操作事件,便于日 后的查询、审计和回溯。
表12-1 云审计服务支持的分布式消息服务 RocketMQ 版操作列表
操作名称 资源类型 事件名称
创建Topic成功 reliability Reliability_Topic_CreationSucces s
创建Topic失败 reliability Reliability_Topic_CreationFailure 修改Topic成功 reliability Reliability_Topic_ModifySuccess 修改Topic失败 reliability Reliability_Topic_ModifyFailure 删除Topic成功 reliability Reliability_Topic_DeletionSucces
s
删除Topic失败 reliability Reliability_Topic_DeletionFailure 创建消费组成功 reliability Reliability_Create_GroupSuccess 创建消费组失败 reliability Reliability_Create_GroupFailure 编辑消费组成功 reliability Reliability_Group_ModifySuccess 编辑消费组失败 reliability Reliability_Group_ModifyFailure 删除消费组成功 reliability Reliability_Group_DeletionSucce
ss
删除消费组失败 reliability Reliability_Group_DeletionFailur e
用户指南 12 审计
12.2 查看云审计日志
操作场景
云审计服务管理控制台保存最近7天的操作记录。
本节介绍如何在云审计服务管理控制台查看最近7天的操作记录。
操作步骤
步骤1 登录云审计服务控制台。
步骤2 单击左侧导航树的“事件列表”,进入事件列表信息页面。
步骤3 事件列表支持通过筛选来查询对应的操作事件。当前事件列表支持以下维度的组合查 询,详细信息如下:
● 事件来源:选择“DMS”。
● 资源类型:选择“reliability”。
● 筛选类型:在下拉框中选择查询条件。
选择事件名称时,还需选择某个具体的事件名称。
选择资源ID时,还需选择某个具体的资源ID。
选择资源名称时,还需选某个具体的资源名称。
● 操作用户:在下拉框中选择某一具体的操作用户,此操作用户指用户级别,而非 租户级别。
● 事件级别:可选项为“所有事件级别”、“Normal”、“Warning”、
“Incident”,只可选择其中一项。
步骤4 在需要查看的记录左侧,单击 展开该记录的详细信息。
图12-1 事件列表
步骤5 在需要查看的记录右侧,单击“查看事件”,弹出一个窗口,显示了该操作事件结构 的详细信息。
----结束
用户指南 12 审计