[doc] add help document for rocketmq (#1874)

This commit is contained in:
liutianyou
2024-04-27 21:42:22 +08:00
committed by GitHub
parent d3209b645f
commit 48e35bee19
4 changed files with 100 additions and 3 deletions
+3 -3
View File
@@ -1,7 +1,7 @@
---
id: influxdb
title: Monitoring: InfluxDB Database Monitoring
sidebar_label: InfluxDB Database
id: influxdb
title: Monitoring InfluxDB Database
sidebar_label: InfluxDB Database
keywords: [open source monitoring system, open source database monitoring, InfluxDB database monitoring]
---
+48
View File
@@ -0,0 +1,48 @@
---
id: rocketmq
title: Monitoring Apache RocketMQ
sidebar_label: Apache RocketMQ
keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ]
---
> Monitor the broker, consumer and other related metrics of RocketMQ.
### Configuration parameters
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| Namesrv Host | IPV4,IPV6 of RocketMQ name server(eg: https://, http://)。 |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique. |
| Port | Port of RocketMQ name server. |
| accessKey | accessKey. |
| secretKey | secretKey. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Collection Metric
#### Metric setcluster
| Metric name | Metric unit | Metric help description |
|-------------------------|-------------|---------------------------------------|
| BrokerId | none | Broker id |
| Address | none | Broker address |
| Version | none | Version |
| Producer_Message_TPS | none | Produce message TPS |
| Consumer_Message_TPS | none | Consume message TPS |
| Yesterday_Produce_Count | none | Number of messages produced yesterday |
| Yesterday_Consume_Count | none | Number of messages consumed yesterday |
| Today_Produce_Count | none | Number of messages produced today |
| Today_Consume_Count | none | Number of messages consumed today |
#### Metric setConsumer
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------|
| Consumer_group | none | Consumer group |
| Client_quantity | none | Number of clients |
| Message_model | none | Message model |
| Consume_type | none | Consume type |
| Consume_tps | none | Consume tps |
| Delay | none | Delay |
@@ -0,0 +1,48 @@
---
id: rocketmq
title: 监控 Apache RocketMQ 消息中间件
sidebar_label: RocketMQ消息中间件
keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件监控 ]
---
> 对 RocketMQ 消息中间件的broker,消费者等相关指标进行监测。
### 配置参数
| 参数名称 | 参数帮助描述 |
|-----------|------------------------------------------------|
| 注册中心Host | RocketMQ注册中心的IPV4,IPV6(eg: https://, http://)。 |
| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 |
| 端口 | 注册中心端口。 |
| accessKey | accessKey。 |
| secretKey | secretKey。 |
| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 |
| 绑定标签 | 用于对监控资源进行分类管理。 |
| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 |
### 采集指标
#### 指标集合:集群
| 指标名称 | 指标单位 | 指标帮助描述 |
|-------------------------|------|------------|
| BrokerId | 无 | Broker唯一ID |
| Address | 无 | Broker地址 |
| Version | 无 | 版本 |
| Producer_Message_TPS | 无 | 生产消息TPS |
| Consumer_Message_TPS | 无 | 消费消息TPS |
| Yesterday_Produce_Count | 无 | 昨天生产消息数 |
| Yesterday_Consume_Count | 无 | 昨天消费消息数 |
| Today_Produce_Count | 无 | 今天生产消息数 |
| Today_Consume_Count | 无 | 今天消费消息数 |
#### 指标集合:消费者
| 指标名称 | 指标单位 | 指标帮助描述 |
|-----------------|------|--------|
| Consumer_group | 无 | 消费者组 |
| Client_quantity | 无 | 客户端数量 |
| Message_model | 无 | 消息模式 |
| Consume_type | 无 | 消费类型 |
| Consume_tps | 无 | 消费TPS |
| Delay | 无 | 延迟 |
+1
View File
@@ -200,6 +200,7 @@
"help/shenyu",
"help/rabbitmq",
"help/activemq",
"help/rocketmq",
"help/spring_gateway",
"help/nacos"
]