From 9dc5b0c9329813cdc49fea0c4b3ca26d7a2fb05f Mon Sep 17 00:00:00 2001 From: yuanziwei Date: Wed, 12 Jun 2024 20:27:05 +0800 Subject: [PATCH 1/3] Support UserGuide for new feature --- docs/1_0_0/UserGuide_CN.md | 9 +++++++-- docs/1_0_0/UserGuide_EN.md | 11 ++++++++--- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/1_0_0/UserGuide_CN.md b/docs/1_0_0/UserGuide_CN.md index 0bf62a4f..a5bb5fa7 100755 --- a/docs/1_0_0/UserGuide_CN.md +++ b/docs/1_0_0/UserGuide_CN.md @@ -17,11 +17,12 @@ ## 主题页面 * 展示所有的主题，可以通过搜索框进行过滤 -* 筛选 普通/重试/死信 主题 +* 筛选 普通/重试/死信 主题（RocketMQ-v5版本支持延迟/顺序/事务消息的筛选） * 添加/更新主题 * clusterName 创建在哪几个cluster上 * brokerName 创建在哪几个broker上 * topicName 主题名 + * messageType 主题类型（RocketMQ-V5版本提供 FIFO/Delay/Normal...） * writeQueueNums 写队列数量 * readQueueNums 读队列数量 * perm //2是写 4是读 6是读写 @@ -34,7 +35,7 @@ * 删除主题 （会删除掉所有broker以及namesrv上的主题配置和路由信息） ## 消费者页面 -* 展示所有的消费组，可以通过搜索框进行过滤 +* 展示所有的消费组，可以通过搜索框进行过滤（V5版本支持FIFO类型过滤，V4会隐藏FIFO过滤选项） * 刷新页面/每隔五秒定时刷新页面 * 按照订阅组/数量/TPS/延迟 进行排序 * 添加/更新消费组 @@ -42,6 +43,7 @@ * brokerName 创建在哪几个broker上 * groupName 消费组名字 * consumeEnable //是否可以消费 FALSE的话将无法进行消费 + * consumeOrderlyEnable //是否开启顺序消费，FIFO类型的订阅组一定需要开启此选项（V5版本提供） * consumeBroadcastEnable //是否可以广播消费 * retryQueueNums //重试队列的大小 * brokerId //正常情况从哪消费 @@ -63,6 +65,9 @@ * 根据消息主题和消息Id进行消息的查询 * 消息详情可以展示这条消息的详细信息，查看消息对应到具体消费组的消费情况（如果异常，可以查看具体的异常信息）。可以向指定的消费组重发消息。 +## 代理服务页面 +* 支持新增代理节点地址，下拉框可以查询和选择已经添加的代理节点 +* 代理节点地址配置：在application.yml中可对proxyAddr和proxyAddrs属性进行配置 ## HTTPS 方式访问Dashboard * HTTPS功能实际上是使用SpringBoot提供的配置功能即可完成，首先，需要有一个SSL KeyStore来存放服务端证书，可以使用本工程所提供的测试密钥库: diff --git a/docs/1_0_0/UserGuide_EN.md b/docs/1_0_0/UserGuide_EN.md index fd469d23..f32eae15 100644 --- a/docs/1_0_0/UserGuide_EN.md +++ b/docs/1_0_0/UserGuide_EN.md @@ -17,11 +17,12 @@ ## Topic Page * show all the topics,you can filter topic by search bar -* filter (Normal/retry/dead) topic +* filter (Normal/retry/dead) topic (RocketMQ-v5 version supports filtering for Delay/FIFO/Transaction topic) * Add/Update Topic * clusterName (create on which cluster) * brokerName (create on which broker) * topicName + * messageType message type(RocketMQ-V5 version can choose FIFO/Delay/Normal...) * writeQueueNums * readQueueNums * perm //2 for write 4 for read 6 for write and read @@ -34,14 +35,15 @@ * DELETE （will delete the topic on all broker and namesrv） ## Consumer Page -* show all the consumers,you can filter consumer by search bar +* show all the consumers,you can filter consumer by search bar(V5 version supports FIFO type filtering, V4 will hide FIFO filtering options) * refresh page/refresh page per 5 seconds * order by SubscriptionGroup/Quantity/TPS/Delay * Add/Update Consumer - * clusterName (create on which cluster) + * clusterName (create on which cluster)(V5 version supports FIFO type filtering, V4 will hide FIFO filtering options) * brokerName (create on which broker) * groupName (consumer group name) * consumeEnable (this group can't consume message if this is false) + * consumeOrderlyEnable (this option must be enabled for FIFO type subscription groups) * consumeBroadcastEnable (can't use broadcast is this is false) * retryQueueNums * brokerId (consume form where when broker is normal) @@ -64,6 +66,9 @@ * look over this message's detail info.you can see the message's consume state(each group has one line),show the exception message if has exception. you can send this message to the group you selected +## Proxy Page +* Support adding new proxy node addresses, dropdown menu allows for querying and selecting proxy nodes that have already been added +* ProxyAddr and ProxyAddrs properties can be configured in application.yml ## Access Dashboard with HTTPS * SpringBoot itself has provided the SSL configuration. You can use the project test Keystore:resources/rmqcngkeystore.jks. The store is generated with the following unix keytool commands: From 2ba9f381894fd494d4fcb56585877511df26d8d2 Mon Sep 17 00:00:00 2001 From: yuanziwei Date: Thu, 13 Jun 2024 15:15:35 +0800 Subject: [PATCH 2/3] update userGuide md --- docs/1_0_0/UserGuide_CN.md | 21 ++++++++++++++------- docs/1_0_0/UserGuide_EN.md | 21 ++++++++++++++------- 2 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/1_0_0/UserGuide_CN.md b/docs/1_0_0/UserGuide_CN.md index a5bb5fa7..291b1c19 100755 --- a/docs/1_0_0/UserGuide_CN.md +++ b/docs/1_0_0/UserGuide_CN.md @@ -17,12 +17,11 @@ ## 主题页面 * 展示所有的主题，可以通过搜索框进行过滤 -* 筛选 普通/重试/死信 主题（RocketMQ-v5版本支持延迟/顺序/事务消息的筛选） +* 筛选 普通/重试/死信 主题 * 添加/更新主题 * clusterName 创建在哪几个cluster上 * brokerName 创建在哪几个broker上 * topicName 主题名 - * messageType 主题类型（RocketMQ-V5版本提供 FIFO/Delay/Normal...） * writeQueueNums 写队列数量 * readQueueNums 读队列数量 * perm //2是写 4是读 6是读写 @@ -35,7 +34,7 @@ * 删除主题 （会删除掉所有broker以及namesrv上的主题配置和路由信息） ## 消费者页面 -* 展示所有的消费组，可以通过搜索框进行过滤（V5版本支持FIFO类型过滤，V4会隐藏FIFO过滤选项） +* 展示所有的消费组，可以通过搜索框进行过滤 * 刷新页面/每隔五秒定时刷新页面 * 按照订阅组/数量/TPS/延迟 进行排序 * 添加/更新消费组 @@ -43,7 +42,6 @@ * brokerName 创建在哪几个broker上 * groupName 消费组名字 * consumeEnable //是否可以消费 FALSE的话将无法进行消费 - * consumeOrderlyEnable //是否开启顺序消费，FIFO类型的订阅组一定需要开启此选项（V5版本提供） * consumeBroadcastEnable //是否可以广播消费 * retryQueueNums //重试队列的大小 * brokerId //正常情况从哪消费 @@ -65,9 +63,18 @@ * 根据消息主题和消息Id进行消息的查询 * 消息详情可以展示这条消息的详细信息，查看消息对应到具体消费组的消费情况（如果异常，可以查看具体的异常信息）。可以向指定的消费组重发消息。 -## 代理服务页面 -* 支持新增代理节点地址，下拉框可以查询和选择已经添加的代理节点 -* 代理节点地址配置：在application.yml中可对proxyAddr和proxyAddrs属性进行配置 +## RocketMQ-V5.0 仪表盘 +* 版本切换 + * RocketMQ右上角可切换不同版本，用户可以自主选择 RocketMQ-5.x 或 RocketMQ-4.x 版本 +* 主题页面 + * 支持延迟/顺序/事务消息的筛选 + * 支持延迟/顺序/事物/普通等多种消息类型主题的新增与更新 +* 消费页面 + * 支持顺序消费类型订阅组的过滤 + * 提供顺序消费类型订阅组的新增与更新，如果需要开启顺序消费，FIFO类型的订阅组一定需要打开consumeOrderlyEnable选项 +* 代理页面（RocketMQ 5.0新增） + * 支持代理节点的新增与查询 + * 支持代理节点地址配置：在application.yml中可对proxyAddr和proxyAddrs属性进行预配置 ## HTTPS 方式访问Dashboard * HTTPS功能实际上是使用SpringBoot提供的配置功能即可完成，首先，需要有一个SSL KeyStore来存放服务端证书，可以使用本工程所提供的测试密钥库: diff --git a/docs/1_0_0/UserGuide_EN.md b/docs/1_0_0/UserGuide_EN.md index f32eae15..d32cffb8 100644 --- a/docs/1_0_0/UserGuide_EN.md +++ b/docs/1_0_0/UserGuide_EN.md @@ -17,12 +17,11 @@ ## Topic Page * show all the topics,you can filter topic by search bar -* filter (Normal/retry/dead) topic (RocketMQ-v5 version supports filtering for Delay/FIFO/Transaction topic) +* filter (Normal/retry/dead) topic * Add/Update Topic * clusterName (create on which cluster) * brokerName (create on which broker) * topicName - * messageType message type(RocketMQ-V5 version can choose FIFO/Delay/Normal...) * writeQueueNums * readQueueNums * perm //2 for write 4 for read 6 for write and read @@ -39,11 +38,10 @@ * refresh page/refresh page per 5 seconds * order by SubscriptionGroup/Quantity/TPS/Delay * Add/Update Consumer - * clusterName (create on which cluster)(V5 version supports FIFO type filtering, V4 will hide FIFO filtering options) + * clusterName (create on which cluster) * brokerName (create on which broker) * groupName (consumer group name) * consumeEnable (this group can't consume message if this is false) - * consumeOrderlyEnable (this option must be enabled for FIFO type subscription groups) * consumeBroadcastEnable (can't use broadcast is this is false) * retryQueueNums * brokerId (consume form where when broker is normal) @@ -66,9 +64,18 @@ * look over this message's detail info.you can see the message's consume state(each group has one line),show the exception message if has exception. you can send this message to the group you selected -## Proxy Page -* Support adding new proxy node addresses, dropdown menu allows for querying and selecting proxy nodes that have already been added -* ProxyAddr and ProxyAddrs properties can be configured in application.yml +## RocketMQ-V5.0 dashboard +* Version switching + * RocketMQ can switch between different versions in the upper right corner, and users can freely choose between RocketMQ-5.X or RocketMQ-4.X versions +* Theme page + * Support filtering of delayed/sequential/transaction messages + * Support the addition and update of multiple message types such as delay, sequence, object, and ordinary themes +* Consumption page + * Support filtering of subscription groups for fifo consumption types + * Provide the addition and update of subscription groups for sequential consumption types. If fifo consumption needs to be enabled, FIFO type subscription groups must have the consumeOrderlyEnable option enabled +* Proxy page (Added in RocketMQ 5.0) + * Support for adding and querying proxy nodes + * Support proxy node address configuration: ProxyAddr and proxyAddrs properties can be pre configured in application.yml ## Access Dashboard with HTTPS * SpringBoot itself has provided the SSL configuration. You can use the project test Keystore:resources/rmqcngkeystore.jks. The store is generated with the following unix keytool commands: From 6c90950c5bd4dbc05172835ba1aab5185a0e5209 Mon Sep 17 00:00:00 2001 From: yuanziwei Date: Thu, 13 Jun 2024 15:16:40 +0800 Subject: [PATCH 3/3] update userGuide md --- docs/1_0_0/UserGuide_EN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/1_0_0/UserGuide_EN.md b/docs/1_0_0/UserGuide_EN.md index d32cffb8..b896dbc8 100644 --- a/docs/1_0_0/UserGuide_EN.md +++ b/docs/1_0_0/UserGuide_EN.md @@ -17,7 +17,7 @@ ## Topic Page * show all the topics,you can filter topic by search bar -* filter (Normal/retry/dead) topic +* filter (Normal/retry/dead) topic * Add/Update Topic * clusterName (create on which cluster) * brokerName (create on which broker) @@ -34,7 +34,7 @@ * DELETE （will delete the topic on all broker and namesrv） ## Consumer Page -* show all the consumers,you can filter consumer by search bar(V5 version supports FIFO type filtering, V4 will hide FIFO filtering options) +* show all the consumers,you can filter consumer by search bar * refresh page/refresh page per 5 seconds * order by SubscriptionGroup/Quantity/TPS/Delay * Add/Update Consumer