You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by aa...@apache.org on 2023/03/07 06:10:44 UTC
[rocketmq-site] branch new-official-website updated (5dad368ab -> c3919bed1)
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a change to branch new-official-website
in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
from 5dad368ab Remove useless license badge (#524)
new b68aa8677 add RocketMQ 5.x metrics definition.
new c3919bed1 Modified some error content for RocketMQ 5.x metrics definition.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/05-bestPractice/_category_.json | 2 +-
docs/06-parameterConfiguration/_category_.json | 2 +-
docs/07-eventbridge/_category_.json | 2 +-
docs/08-mqtt/_category_.json | 2 +-
docs/09-streams/_category_.json | 2 +-
docs/10-connect/_category_.json | 2 +-
docs/11-contributionGuide/_category_.json | 2 +-
.../version-5.0.json | 4 +
.../version-5.0/12-observability/01metrics.md | 98 +++++++++++++++++++++
.../picture/observability/message-accumulation.png | Bin 0 -> 28580 bytes
.../observability/pushconsumer-consumption.png | Bin 0 -> 44698 bytes
.../version-5.0/06-bestPractice/_category_.json | 2 +-
.../version-5.0/07-eventbridge/_category_.json | 2 +-
versioned_docs/version-5.0/08-mqtt/_category_.json | 2 +-
.../version-5.0/09-streams/_category_.json | 2 +-
.../version-5.0/12-observability/01metrics.md | 95 ++++++++++++++++++++
.../version-5.0/12-observability/_category_.json | 4 +
.../v5/observability/message-accumulation.png | Bin 0 -> 30271 bytes
.../v5/observability/pushconsumer-consumption.png | Bin 0 -> 63006 bytes
19 files changed, 212 insertions(+), 11 deletions(-)
create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/message-accumulation.png
create mode 100644 i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/pushconsumer-consumption.png
create mode 100644 versioned_docs/version-5.0/12-observability/01metrics.md
create mode 100644 versioned_docs/version-5.0/12-observability/_category_.json
create mode 100644 versioned_docs/version-5.0/picture/v5/observability/message-accumulation.png
create mode 100644 versioned_docs/version-5.0/picture/v5/observability/pushconsumer-consumption.png
[rocketmq-site] 02/02: Modified some error content for RocketMQ 5.x metrics definition.
Posted by aa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch new-official-website
in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
commit c3919bed1df9f495f6690b0d3c6c79493e262a31
Author: wenting.ywt <unknown>
AuthorDate: Tue Mar 7 13:55:48 2023 +0800
Modified some error content for RocketMQ 5.x metrics definition.
---
.../version-5.0/12-observability/01metrics.md | 16 ++++++----------
versioned_docs/version-5.0/12-observability/01metrics.md | 11 +++--------
2 files changed, 9 insertions(+), 18 deletions(-)
diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
index 5b14e0304..81ab8f8cc 100644
--- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
+++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
@@ -5,6 +5,8 @@ RocketMQ exposes the following metrics in Prometheus format. You can monitor you
- Producer metrics
- Consumer metrics
+>Version support: The following metrics for RocketMQ were introduced since 5.1.0 and only support the broker.
+
## Details of metrics
@@ -16,9 +18,9 @@ The following table describes the labels of the metrics that are related to the
- cluster: RocketMQ cluster name.
- node_type: the type of service node, whitch includes the following:proxy,broker,nameserver.
-- node_id:the ID of the service node.
+- node_id: the ID of the service node.
- topic: the topic of RocketMQ.
-- message_type: the type of a message, which includes the following:<br />Normal:normal messages;<br />FIFO:ordered messages;<br />Transaction:Transactional messages;<br />Delay:scheduled or delayed messages.
+- message_type: the type of a message, which includes the following:<br />normal:normal messages;<br />fifo:ordered messages;<br />transaction:Transactional messages;<br />delay:scheduled or delayed messages.
- consumer_group: the ID of the consumer group.
| Type | Name | Unit | Description | Label |
@@ -34,12 +36,6 @@ The following table describes the labels of the metrics that are related to the
| gauge | rocketmq_consumer_lag_latency | millisecond | The delayed time before messages are consumed. | cluster,node_type,node_id,topic, consumer_group |
| counter | rocketmq_send_to_dlq_messages_total | count | The number of messages that are sent to the dead-letter queue. | cluster,node_type,node_id,topic, consumer_group |
| histogram | rocketmq_rpc_latency | millisecond | The rpc call latency | cluster,node_typ,node_id,protocol_type,request_code,response_code |
-| gauge | rocketmq_storage_size | byte | The size of the storage space that is used by the node. | cluster,node_type,node_id |
-| counter | rocketmq_storage_read_bytes_total | byte | The amount of data read by the storage layer. | cluster,node_type,node_id,topic |
-| gauge | rocketmq_storage_read_bytes_max | byte | Peak data read per second of the storage layer. | cluster,node_type,node_id,topic |
-| counter | rocketmq_storage_write_bytes_total | byte | The amount of data write to the storage layer. | cluster,node_type,node_id,topic |
-| gauge | rocketmq_storage_write_bytes_max | byte | Peak data write per second to the storage layer. | cluster,node_type,node_id,topic |
-| Histogram | rocketmq_storage_write_latency | millisecond | The latency of messages sizes. This metric is counted only when messages are sent. The following shows the distribution ranges:<br />le_1_ns: ≤ 1 ns<br /> le_10_ns: ≤ 10 ns<br />le_100_ns: ≤ 100 ns<br />le_1000_ns: ≤ 1 ms<br />le_overflow: > 1 ms | cluster,node_type,node_id,topic,message_type |
| gauge | rocketmq_storage_message_reserve_time | millisecond | Message retention time. | cluster,node_type,node_id |
| gauge | rocketmq_storage_dispatch_behind_bytes | byte | Undispatched message size. | cluster,node_type,node_id |
| gauge | rocketmq_storage_flush_behind_bytes | byte | Unflushed messsage size. | cluster,node_type,node_id |
@@ -52,9 +48,9 @@ The following table describes the labels of the metrics that are related to the
- cluster: RocketMQ cluster name.
- node_type: the type of service node, whitch includes the following:proxy,broker,nameserver.
-- node_id:the ID of the service node.
+- node_id: the ID of the service node.
- topic: the topic of Message Queue for Apache RocketMQ.
-- message_type: the type of a message, which includes the following:<br />Normal:normal messages;<br />FIFO:ordered messages;<br />Transaction:Transactional messages;<br />Delay:scheduled or delayed messages.
+- message_type: the type of a message, which includes the following:<br />normal:normal messages;<br />fifo:ordered messages;<br />transaction:Transactional messages;<br />delay:scheduled or delayed messages.
- client_id: the ID of the client.
- invocation_status: the result of the API call for sending messages, which includes success and failure.
diff --git a/versioned_docs/version-5.0/12-observability/01metrics.md b/versioned_docs/version-5.0/12-observability/01metrics.md
index 0c5e36c31..a71a066c5 100644
--- a/versioned_docs/version-5.0/12-observability/01metrics.md
+++ b/versioned_docs/version-5.0/12-observability/01metrics.md
@@ -1,10 +1,11 @@
# Metrics
-RocketMQ以Prometheus格式公开以下指标。您可以使用这些指标监视您的集群。
+RocketMQ 以 Prometheus 格式公开以下指标。您可以使用这些指标监视您的集群。
- 服务端Metrics指标
- 生产者Metrics指标
- 消费者Metrics指标
+>版本支持：以下指标 Metrics 是从 5.1.0 版本开始支持。
## Metrics指标详情
@@ -33,12 +34,6 @@ RocketMQ以Prometheus格式公开以下指标。您可以使用这些指标监
| gauge | rocketmq_consumer_lag_latency | millisecond | 消费处理延迟时间。 | cluster,node_type,node_id,topic, consumer_group |
| counter | rocketmq_send_to_dlq_messages_total | count | 转为死信状态的消息量。（变成死信状态指的是消息达到最大重投次数后不再投递） | cluster,node_type,node_id,topic, consumer_group |
| histogram | rocketmq_rpc_latency | millisecond | rpc 调用耗时：<br />le_1_ms<br />le_3_ms<br />le_5_ms<br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_overflow | cluster,node_typ,node_id,protocol_type,request_code,response_code |
-| gauge | rocketmq_storage_size | byte | 存储大小，包含所有文件。| cluster,node_type,node_id |
-| counter | rocketmq_storage_read_bytes_total | byte | 储存层读取数据量。 | cluster,node_type,node_id,topic |
-| gauge | rocketmq_storage_read_bytes_max | byte | 储存层每秒读取数据量峰值。 | cluster,node_type,node_id,topic |
-| counter | rocketmq_storage_write_bytes_total | byte | 储存层写入数据量。| cluster,node_type,node_id,topic |
-| gauge | rocketmq_storage_write_bytes_max | byte | 储存层每秒写入数据量峰值。 | cluster,node_type,node_id,topic |
-| Histogram | rocketmq_storage_write_latency | millisecond | 储存层写入消息耗时：<br />le_1_ns: ≤ 1 ns<br /> le_10_ns: ≤ 10 ns<br />le_100_ns: ≤ 100 ns<br />le_1000_ns: ≤ 1 ms<br />le_overflow: > 1 ms | cluster,node_type,node_id,topic,message_type |
| gauge | rocketmq_storage_message_reserve_time | millisecond | 储存层消息保存时间（broker 硬盘上最早一条消息储存时间和当前时间作差） | cluster,node_type,node_id |
| gauge | rocketmq_storage_dispatch_behind_bytes | byte | dispatch 落后大小 | cluster,node_type,node_id |
| gauge | rocketmq_storage_flush_behind_bytes | byte | 刷盘落后大小。 | cluster,node_type,node_id |
@@ -88,7 +83,7 @@ RocketMQ以Prometheus格式公开以下指标。您可以使用这些指标监
| 已就绪消息（ready messages） | 消息在消息队列RocketMQ版服务端已就绪，对消费者可见可被消费的消息。 | 最大消费位点－最晚一条拉取消息的位点 |
| 已就绪消息的就绪时间（ready time） | 普通消息、顺序消息：消息存储到服务端的时间。 <br /> 定时/延时消息：消息定时或延时结束的时间。 <br /> 事务消息：事务提交的时间。 | -- |
| 已就绪消息的排队时间（ready message queue time）| 该时间反应消费者拉取消息的及时性。 | 当前时间－最早一条就绪消息的就绪时间 |
-| 消费处理滞后时间（comsumer lag time） | 该时间反应消费者完成消息处理的及时性。 | 当前时间－最早一条未提交消息的就绪时间|
+| 消费处理滞后时间（consumer lag time） | 该时间反应消费者完成消息处理的及时性。 | 当前时间－最早一条未提交消息的就绪时间|
### PushConsumer 消费场景
[rocketmq-site] 01/02: add RocketMQ 5.x metrics definition.
Posted by aa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch new-official-website
in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
commit b68aa86777439d0a5c940150ff959677622fb134
Author: wenting.ywt <unknown>
AuthorDate: Mon Mar 6 17:41:57 2023 +0800
add RocketMQ 5.x metrics definition.
---
docs/05-bestPractice/_category_.json | 2 +-
docs/06-parameterConfiguration/_category_.json | 2 +-
docs/07-eventbridge/_category_.json | 2 +-
docs/08-mqtt/_category_.json | 2 +-
docs/09-streams/_category_.json | 2 +-
docs/10-connect/_category_.json | 2 +-
docs/11-contributionGuide/_category_.json | 2 +-
.../version-5.0.json | 4 +
.../version-5.0/12-observability/01metrics.md | 102 +++++++++++++++++++++
.../picture/observability/message-accumulation.png | Bin 0 -> 28580 bytes
.../observability/pushconsumer-consumption.png | Bin 0 -> 44698 bytes
.../version-5.0/06-bestPractice/_category_.json | 2 +-
.../version-5.0/07-eventbridge/_category_.json | 2 +-
versioned_docs/version-5.0/08-mqtt/_category_.json | 2 +-
.../version-5.0/09-streams/_category_.json | 2 +-
.../version-5.0/12-observability/01metrics.md | 100 ++++++++++++++++++++
.../version-5.0/12-observability/_category_.json | 4 +
.../v5/observability/message-accumulation.png | Bin 0 -> 30271 bytes
.../v5/observability/pushconsumer-consumption.png | Bin 0 -> 63006 bytes
19 files changed, 221 insertions(+), 11 deletions(-)
diff --git a/docs/05-bestPractice/_category_.json b/docs/05-bestPractice/_category_.json
index e18efebcd..f5b6e828d 100644
--- a/docs/05-bestPractice/_category_.json
+++ b/docs/05-bestPractice/_category_.json
@@ -1,4 +1,4 @@
{
"label": "最佳实践",
- "position": 5
+ "position": 6
}
\ No newline at end of file
diff --git a/docs/06-parameterConfiguration/_category_.json b/docs/06-parameterConfiguration/_category_.json
index 4a6e6208e..9f26dd3f8 100644
--- a/docs/06-parameterConfiguration/_category_.json
+++ b/docs/06-parameterConfiguration/_category_.json
@@ -1,4 +1,4 @@
{
"label": "参数配置",
- "position": 6
+ "position": 7
}
\ No newline at end of file
diff --git a/docs/07-eventbridge/_category_.json b/docs/07-eventbridge/_category_.json
index ad7da314c..d7b5d7b32 100644
--- a/docs/07-eventbridge/_category_.json
+++ b/docs/07-eventbridge/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ EventBridge",
- "position": 7
+ "position": 8
}
\ No newline at end of file
diff --git a/docs/08-mqtt/_category_.json b/docs/08-mqtt/_category_.json
index ae8b03503..46c4ebf84 100644
--- a/docs/08-mqtt/_category_.json
+++ b/docs/08-mqtt/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ MQTT",
- "position": 8
+ "position": 9
}
\ No newline at end of file
diff --git a/docs/09-streams/_category_.json b/docs/09-streams/_category_.json
index dcf4b9fac..5b2927ebb 100644
--- a/docs/09-streams/_category_.json
+++ b/docs/09-streams/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ Streams",
- "position": 9
+ "position": 10
}
\ No newline at end of file
diff --git a/docs/10-connect/_category_.json b/docs/10-connect/_category_.json
index 26bb614d4..f2a19d0f2 100644
--- a/docs/10-connect/_category_.json
+++ b/docs/10-connect/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ Connect",
- "position": 10
+ "position": 11
}
\ No newline at end of file
diff --git a/docs/11-contributionGuide/_category_.json b/docs/11-contributionGuide/_category_.json
index b9a57ffde..b963d7dd5 100644
--- a/docs/11-contributionGuide/_category_.json
+++ b/docs/11-contributionGuide/_category_.json
@@ -1,4 +1,4 @@
{
"label": "贡献指南",
- "position": 11
+ "position": 12
}
\ No newline at end of file
diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0.json b/i18n/en/docusaurus-plugin-content-docs/version-5.0.json
index d7f4846d2..c9740a308 100644
--- a/i18n/en/docusaurus-plugin-content-docs/version-5.0.json
+++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0.json
@@ -23,6 +23,10 @@
"message": "Deployment & Operations",
"description": "The label for category 部署 & 运维 in sidebar myAutogeneratedSidebar"
},
+ "sidebar.myAutogeneratedSidebar.category.可观测": {
+ "message": "Observability",
+ "description": "The label for category 可观测 in sidebar myAutogeneratedSidebar"
+ },
"sidebar.myAutogeneratedSidebar.category.最佳实践": {
"message": "Best Practice",
"description": "The label for category 最佳实践 in sidebar myAutogeneratedSidebar"
diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
new file mode 100644
index 000000000..5b14e0304
--- /dev/null
+++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
@@ -0,0 +1,102 @@
+# Metrics
+RocketMQ exposes the following metrics in Prometheus format. You can monitor your clusters with those metrics.
+
+- Broker metrics
+- Producer metrics
+- Consumer metrics
+
+
+## Details of metrics
+
+### Metric types
+The standard for defining metrics in RocketMQ complies with that for defining the metrics in open source Prometheus. The metric types that RocketMQ offers include counters, gauges, and histograms. For more information, see [METRIC TYPES](https://prometheus.io/docs/concepts/metric_types/).
+
+### Broker metrics
+The following table describes the labels of the metrics that are related to the Message Queue for Apache RocketMQ broker.
+
+- cluster: RocketMQ cluster name.
+- node_type: the type of service node, whitch includes the following:proxy,broker,nameserver.
+- node_id:the ID of the service node.
+- topic: the topic of RocketMQ.
+- message_type: the type of a message, which includes the following:<br />Normal:normal messages;<br />FIFO:ordered messages;<br />Transaction:Transactional messages;<br />Delay:scheduled or delayed messages.
+- consumer_group: the ID of the consumer group.
+
+| Type | Name | Unit | Description | Label |
+| --- | ----- | --- | ---------- | --- |
+| counter | rocketmq_messages_in_total | count | The number of messages that are produced. | cluster,node_type,node_id,topic,message_type |
+| counter | rocketmq_messages_out_total | count | The number of messages that are consumed. | cluster,node_type,node_id,topic, consumer_group|
+| counter | rocketmq_throughput_in_total | byte | The write throughput that are produced. | cluster,node_type,node_id,topic,message_type |
+| counter | rocketmq_throughput_out_total | byte | The read throughput that are produced. | cluster,node_type,node_id,topic, consumer_group|
+| histogram | rocketmq_message_size | byte | The distribution of message sizes. This metric is counted only when messages are sent. The following shows the distribution ranges:<br />le_1_kb: ≤ 1 KB<br /> le_4_kb: ≤ 4 KB<br />le_512_kb: ≤ 512 KB<br />le_1_mb: ≤ 1 MB<br />le_2_mb: ≤ 2 MB<br />le_4_mb: ≤ 4 MB<br />le_overflow: > 4 MB | cluster,node_type,node_id,topic,message_type |
+| gauge | rocketmq_consumer_ready_messages | count | The number of ready messages. | cluster,node_type,node_id,topic, consumer_group |
+| gauge | rocketmq_consumer_inflight_messages | count | The number of inflight messages. | cluster,node_type,node_id,topic, consumer_group |
+| gauge | rocketmq_consumer_queueing_latency | millisecond | Ready messages queueing delay time. | cluster,node_type,node_id,topic, consumer_group |
+| gauge | rocketmq_consumer_lag_latency | millisecond | The delayed time before messages are consumed. | cluster,node_type,node_id,topic, consumer_group |
+| counter | rocketmq_send_to_dlq_messages_total | count | The number of messages that are sent to the dead-letter queue. | cluster,node_type,node_id,topic, consumer_group |
+| histogram | rocketmq_rpc_latency | millisecond | The rpc call latency | cluster,node_typ,node_id,protocol_type,request_code,response_code |
+| gauge | rocketmq_storage_size | byte | The size of the storage space that is used by the node. | cluster,node_type,node_id |
+| counter | rocketmq_storage_read_bytes_total | byte | The amount of data read by the storage layer. | cluster,node_type,node_id,topic |
+| gauge | rocketmq_storage_read_bytes_max | byte | Peak data read per second of the storage layer. | cluster,node_type,node_id,topic |
+| counter | rocketmq_storage_write_bytes_total | byte | The amount of data write to the storage layer. | cluster,node_type,node_id,topic |
+| gauge | rocketmq_storage_write_bytes_max | byte | Peak data write per second to the storage layer. | cluster,node_type,node_id,topic |
+| Histogram | rocketmq_storage_write_latency | millisecond | The latency of messages sizes. This metric is counted only when messages are sent. The following shows the distribution ranges:<br />le_1_ns: ≤ 1 ns<br /> le_10_ns: ≤ 10 ns<br />le_100_ns: ≤ 100 ns<br />le_1000_ns: ≤ 1 ms<br />le_overflow: > 1 ms | cluster,node_type,node_id,topic,message_type |
+| gauge | rocketmq_storage_message_reserve_time | millisecond | Message retention time. | cluster,node_type,node_id |
+| gauge | rocketmq_storage_dispatch_behind_bytes | byte | Undispatched message size. | cluster,node_type,node_id |
+| gauge | rocketmq_storage_flush_behind_bytes | byte | Unflushed messsage size. | cluster,node_type,node_id |
+| gauge | rocketmq_thread_pool_wartermark | count | The number of tasks queued in the thread pool. | cluster,node_type,node_id,name |
+
+
+
+### Producer metrics
+The following table describes the labels of the metrics that are related to the producers in Message Queue for Apache RocketMQ.
+
+- cluster: RocketMQ cluster name.
+- node_type: the type of service node, whitch includes the following:proxy,broker,nameserver.
+- node_id:the ID of the service node.
+- topic: the topic of Message Queue for Apache RocketMQ.
+- message_type: the type of a message, which includes the following:<br />Normal:normal messages;<br />FIFO:ordered messages;<br />Transaction:Transactional messages;<br />Delay:scheduled or delayed messages.
+- client_id: the ID of the client.
+- invocation_status: the result of the API call for sending messages, which includes success and failure.
+
+| Type | Name | Unit | Description | Label |
+| --- | ----- | --- | ---------- | --- |
+| Histogram | rocketmq_send_cost_time | millisecond | The distribution of production API call time. The following shows the distribution ranges: <br />le_1_ms <br />le_5_ms<br />le_10_ms<br />le_20_ms <br />le_50_ms <br />le_200_ms<br />le_500_ms <br />le_overflow | topic,client_id,invocation_status |
+
+
+### Consumer metrics
+The following table describes the labels of the metrics that are related to the consumers in Message Queue for Apache RocketMQ.
+
+- topic: the topic of Message Queue for Apache RocketMQ.
+- consumer_group: the ID of the consumer group.
+- client_id: the ID of the client.
+- invocation_status: the result of the API call for sending messages, which includes success and failure.
+
+| Type | Name | Unit | Description | Label |
+| --- | ----- | --- | ---------- | --- |
+| Histogram | rocketmq_process_time | millisecond | The distribution of message process time.The following shows the distribution ranges: <br />le_1_ms <br />le_5_ms <br />le_10_ms<br />le_100_ms <br />le_10000_ms<br />le_60000_ms <br />le_overflow | topic,consumer_group,client_id,invocation_status |
+| gauge | rocketmq_consumer_cached_messages | message | The number of messages in the local buffer queue of PushConsumer. | topic,consumer_group,client_id |
+| gauge | rocketmq_consumer_cached_bytes | byte | The total size of messages in the local buffer queue of PushConsumer. | topic,consumer_group,client_id |
+| Histogram | rocketmq_await_time | millisecond | The distribution of queuing time for messages in the local buffer queue of PushConsumer. The following shows the distribution ranges:<br />le_1_ms<br /> le_5_ms<br />le_20_ms<br />le_100_ms <br />le_1000_ms<br /> le_5000_ms <br />le_10000_ms<br />le_overflow | topic,consumer_group,client_id |
+
+
+## Background information
+RocketMQ defines metrics based on the following business scenarios.
+
+### Message accumulation scenarios
+<br />The above figure shows the number and duration of messages in different stages. By monitoring these metrics, you can determine whether the business consumption is abnormal. The following table describes the meaning of these metrics and the formulas that are used to calculate these metrics.
+
+| Name | Description | Formula |
+| --- | --- | --- |
+| Inflight messages | The number of messages being processed by consumer but not acked yet | Offset of the latest pulled message - Offset of the latest committed message |
+| Ready messages | The number of messages that are ready for consumption. | Maximum offset - Offset of the latest pulled message |
+| Ready time | normal message or ordered message:the time when the message is stored to the broker. <br /> Scheduled message:timing end time. <br /> Transactional message: transaction commit time. | -- |
+| Ready message queue time | The time interval between the ready time of the earliest ready message and the current time. This time reflects the timeliness of consumers pulling messages. | Current time - Ready time of the earliest ready message |
+| Consumer lag time | The time difference between the ready time of the earliest unacked message and the current moment.<br />This time reflects the timeliness of the consumer to complete message processing. | Current time - Ready time of the earliest unacked message |
+
+
+### PushConsumer consumption scenarios
+In PushConsumer, real-time message processing capability is implemented based on the typical Reactor thread model inside the SDK.As shown below, the SDK has a built-in long polling thread that asynchronously pulls messages into the SDK's built-in buffer queue and then separately commits them to the consumer thread, triggering the listener to execute the local consumption logic.<br /><br />The metrics of local bu [...]
+
+- Number of messages in the local buffer queue: Total number of messages in the local buffer queue.
+- Message size in the local buffer queue: The sum of all message sizes in the local buffer queue.
+- Message waiting time: the time that the message is temporarily cached in the local buffer queue waiting to be processed.
diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/message-accumulation.png b/i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/message-accumulation.png
new file mode 100644
index 000000000..88badec5e
Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/message-accumulation.png differ
diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/pushconsumer-consumption.png b/i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/pushconsumer-consumption.png
new file mode 100644
index 000000000..92a8b9eda
Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/version-5.0/picture/observability/pushconsumer-consumption.png differ
diff --git a/versioned_docs/version-5.0/06-bestPractice/_category_.json b/versioned_docs/version-5.0/06-bestPractice/_category_.json
index f5b6e828d..e11e809e9 100644
--- a/versioned_docs/version-5.0/06-bestPractice/_category_.json
+++ b/versioned_docs/version-5.0/06-bestPractice/_category_.json
@@ -1,4 +1,4 @@
{
"label": "最佳实践",
- "position": 6
+ "position": 7
}
\ No newline at end of file
diff --git a/versioned_docs/version-5.0/07-eventbridge/_category_.json b/versioned_docs/version-5.0/07-eventbridge/_category_.json
index ad7da314c..d7b5d7b32 100644
--- a/versioned_docs/version-5.0/07-eventbridge/_category_.json
+++ b/versioned_docs/version-5.0/07-eventbridge/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ EventBridge",
- "position": 7
+ "position": 8
}
\ No newline at end of file
diff --git a/versioned_docs/version-5.0/08-mqtt/_category_.json b/versioned_docs/version-5.0/08-mqtt/_category_.json
index ae8b03503..46c4ebf84 100644
--- a/versioned_docs/version-5.0/08-mqtt/_category_.json
+++ b/versioned_docs/version-5.0/08-mqtt/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ MQTT",
- "position": 8
+ "position": 9
}
\ No newline at end of file
diff --git a/versioned_docs/version-5.0/09-streams/_category_.json b/versioned_docs/version-5.0/09-streams/_category_.json
index dcf4b9fac..849a4ad12 100644
--- a/versioned_docs/version-5.0/09-streams/_category_.json
+++ b/versioned_docs/version-5.0/09-streams/_category_.json
@@ -1,4 +1,4 @@
{
"label": "RocketMQ Streams",
- "position": 9
+ "position": 12
}
\ No newline at end of file
diff --git a/versioned_docs/version-5.0/12-observability/01metrics.md b/versioned_docs/version-5.0/12-observability/01metrics.md
new file mode 100644
index 000000000..0c5e36c31
--- /dev/null
+++ b/versioned_docs/version-5.0/12-observability/01metrics.md
@@ -0,0 +1,100 @@
+# Metrics
+RocketMQ以Prometheus格式公开以下指标。您可以使用这些指标监视您的集群。
+
+- 服务端Metrics指标
+- 生产者Metrics指标
+- 消费者Metrics指标
+
+
+## Metrics指标详情
+
+### Metric types
+消息队列RocketMQ版定义的Metrics完全兼容开源Prometheus的标准，提供的Metrics的类型为Counter、Gauge和Histogram。更多信息，请参见 [METRIC TYPES](https://prometheus.io/docs/concepts/metric_types/)。
+
+### 服务端Metrics指标
+消息队列RocketMQ版服务端相关Metrics指标中Label的说明如下：
+- cluster: RocketMQ 集群名称。
+- node_type: 服务节点类型。枚举值包含proxy、broker、nameserver。
+- node_id: 服务节点ID。
+- topic: 消息队列RocketMQ的主题。
+- message_type: 消息类型。有以下类型:<br />Normal:普通消息;<br />FIFO:顺序消息;<br />Transaction:事务消息;<br />Delay:定时/延时消息.
+- consumer_group: 消费者 ID。
+
+| Metrics类型 | Metrics name | 单位 | 指标说明 | Label |
+| --- | ----- | --- | ---------- | --- |
+| counter | rocketmq_messages_in_total | count | 消息生产数量。| cluster,node_type,node_id,topic,message_type |
+| counter | rocketmq_messages_out_total | count | 消息消费数量。| cluster,node_type,node_id,topic, consumer_group|
+| counter | rocketmq_throughput_in_total | byte | 消息生产流入服务端的吞吐量。| cluster,node_type,node_id,topic,message_type |
+| counter | rocketmq_throughput_out_total | byte | 消息消费从服务端流出的吞吐量。| cluster,node_type,node_id,topic, consumer_group|
+| histogram | rocketmq_message_size | byte | 消息大小的分布情况，发送成功时统计。分布区间如下：<br />le_1_kb: ≤ 1 KB<br /> le_4_kb: ≤ 4 KB<br />le_512_kb: ≤ 512 KB<br />le_1_mb: ≤ 1 MB<br />le_2_mb: ≤ 2 MB<br />le_4_mb: ≤ 4 MB<br />le_overflow: > 4 MB | cluster,node_type,node_id,topic,message_type |
+| gauge | rocketmq_consumer_ready_messages | count | 已就绪消息量。| cluster,node_type,node_id,topic, consumer_group |
+| gauge | rocketmq_consumer_inflight_messages | count | 处理中消息量。| cluster,node_type,node_id,topic, consumer_group |
+| gauge | rocketmq_consumer_queueing_latency | millisecond | 已就绪消息排队延迟时间。 | cluster,node_type,node_id,topic, consumer_group |
+| gauge | rocketmq_consumer_lag_latency | millisecond | 消费处理延迟时间。 | cluster,node_type,node_id,topic, consumer_group |
+| counter | rocketmq_send_to_dlq_messages_total | count | 转为死信状态的消息量。（变成死信状态指的是消息达到最大重投次数后不再投递） | cluster,node_type,node_id,topic, consumer_group |
+| histogram | rocketmq_rpc_latency | millisecond | rpc 调用耗时：<br />le_1_ms<br />le_3_ms<br />le_5_ms<br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_overflow | cluster,node_typ,node_id,protocol_type,request_code,response_code |
+| gauge | rocketmq_storage_size | byte | 存储大小，包含所有文件。| cluster,node_type,node_id |
+| counter | rocketmq_storage_read_bytes_total | byte | 储存层读取数据量。 | cluster,node_type,node_id,topic |
+| gauge | rocketmq_storage_read_bytes_max | byte | 储存层每秒读取数据量峰值。 | cluster,node_type,node_id,topic |
+| counter | rocketmq_storage_write_bytes_total | byte | 储存层写入数据量。| cluster,node_type,node_id,topic |
+| gauge | rocketmq_storage_write_bytes_max | byte | 储存层每秒写入数据量峰值。 | cluster,node_type,node_id,topic |
+| Histogram | rocketmq_storage_write_latency | millisecond | 储存层写入消息耗时：<br />le_1_ns: ≤ 1 ns<br /> le_10_ns: ≤ 10 ns<br />le_100_ns: ≤ 100 ns<br />le_1000_ns: ≤ 1 ms<br />le_overflow: > 1 ms | cluster,node_type,node_id,topic,message_type |
+| gauge | rocketmq_storage_message_reserve_time | millisecond | 储存层消息保存时间（broker 硬盘上最早一条消息储存时间和当前时间作差） | cluster,node_type,node_id |
+| gauge | rocketmq_storage_dispatch_behind_bytes | byte | dispatch 落后大小 | cluster,node_type,node_id |
+| gauge | rocketmq_storage_flush_behind_bytes | byte | 刷盘落后大小。 | cluster,node_type,node_id |
+| gauge | rocketmq_thread_pool_wartermark | count | 线程池排队数 | cluster,node_type,node_id,name |
+
+
+
+### 生产者Metrics指标
+消息队列RocketMQ版生产者相关Metrics指标中Label的说明如下：
+- cluster: RocketMQ 集群名称。
+- node_type: 服务节点类型。枚举值包含proxy、broker、nameserver。
+- node_id: 服务节点ID。
+- topic: 消息队列RocketMQ的主题。
+- message_type: 消息类型。有以下类型:<br />Normal:普通消息;<br />FIFO:顺序消息;<br />Transaction:事务消息;<br />Delay:定时/延时消息.
+- client_id: 客户端ID。
+- invocation_status: 消息发送接口调用结果，枚举值包含 success 和 failure。
+
+| Metrics类型 | Metrics name | 单位 | 指标说明 | Label |
+| --- | ----- | --- | ---------- | --- |
+| Histogram | rocketmq_send_cost_time | millisecond | 调用消息发送接口成功的耗时分布情况。分布区间如下：: <br />le_1_ms <br />le_5_ms<br />le_10_ms<br />le_20_ms <br />le_50_ms <br />le_200_ms<br />le_500_ms <br />le_overflow | topic,client_id,invocation_status |
+
+
+### 消费者Metrics指标
+消息队列RocketMQ版消费者相关Metrics指标中Label的说明如下：
+- topic: 消息队列RocketMQ的主题。
+- consumer_group: 消费者分组ID。
+- client_id: 客户端ID。
+- invocation_status: 消费结果, 枚举值包含 success 和 failure。
+
+| Metrics类型 | Metrics name | 单位 | 指标说明 | Label |
+| --- | ----- | --- | ---------- | --- |
+| Histogram | rocketmq_process_time | millisecond | PushConsumer的消息处理耗时分布情况.分布区间如下: <br />le_1_ms <br />le_5_ms <br />le_10_ms<br />le_100_ms <br />le_10000_ms<br />le_60000_ms <br />le_overflow | topic,consumer_group,client_id,invocation_status |
+| gauge | rocketmq_consumer_cached_messages | message | PushConsumer本地缓冲队列中的消息条数。| topic,consumer_group,client_id |
+| gauge | rocketmq_consumer_cached_bytes | byte | PushConsumer本地缓冲队列中消息的总大小。| topic,consumer_group,client_id |
+| Histogram | rocketmq_await_time | millisecond | 消息在PushConsumer本地缓冲队列中的排队时间的分布情况:<br />le_1_ms<br /> le_5_ms<br />le_20_ms<br />le_100_ms <br />le_1000_ms<br /> le_5000_ms <br />le_10000_ms<br />le_overflow | topic,consumer_group,client_id |
+
+
+## 指标业务场景
+消息队列RocketMQ版主要基于以下业务场景定义Metrics指标.
+
+### 消息堆积场景
+<br />上图表示指定主题的某一队列中各消息的状态，消息队列RocketMQ版将处于不同处理阶段的消息数量和耗时进行统计，这些指标可直接反映队列中消息的处理速率和堆积情况，通过观察这些指标可初步判断业务的消费是否异常。具体的指标含义和计算公式如下：
+
+| 名称 | 描述 | 计算公式 |
+| --- | --- | --- |
+| 处理中的消息（inflight messages） | 在消费者客户端正在处理，但客户端还未返回消费结果的消息。 | 最晚一条拉取消息的位点－最晚一条提交消息的位点 |
+| 已就绪消息（ready messages） | 消息在消息队列RocketMQ版服务端已就绪，对消费者可见可被消费的消息。 | 最大消费位点－最晚一条拉取消息的位点 |
+| 已就绪消息的就绪时间（ready time） | 普通消息、顺序消息：消息存储到服务端的时间。 <br /> 定时/延时消息：消息定时或延时结束的时间。 <br /> 事务消息：事务提交的时间。 | -- |
+| 已就绪消息的排队时间（ready message queue time）| 该时间反应消费者拉取消息的及时性。 | 当前时间－最早一条就绪消息的就绪时间 |
+| 消费处理滞后时间（comsumer lag time） | 该时间反应消费者完成消息处理的及时性。 | 当前时间－最早一条未提交消息的就绪时间|
+
+
+### PushConsumer 消费场景
+在PushConsumer类型中，消息的实时处理能力是基于SDK内部的典型Reactor线程模型实现的。如下图所示，SDK内置了一个长轮询线程，先将消息异步拉取到SDK内置的缓存队列中，再分别提交到消费线程中，触发监听器执行本地消费逻辑。<br /><br />在PushConsumer消费场景下，本地缓冲队列相关指标如下：
+
+- 本地缓冲队列中的消息量：本地缓冲队列中的消息总条数。
+- 本地缓冲队列中的消息大小：本地缓冲队列中所有消息大小的总和。
+- 消息等待处理时间：消息暂存在本地缓冲队列中的时间。
+
diff --git a/versioned_docs/version-5.0/12-observability/_category_.json b/versioned_docs/version-5.0/12-observability/_category_.json
new file mode 100644
index 000000000..5afa78399
--- /dev/null
+++ b/versioned_docs/version-5.0/12-observability/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "可观测",
+ "position": 6
+}
\ No newline at end of file
diff --git a/versioned_docs/version-5.0/picture/v5/observability/message-accumulation.png b/versioned_docs/version-5.0/picture/v5/observability/message-accumulation.png
new file mode 100644
index 000000000..a3e6e0317
Binary files /dev/null and b/versioned_docs/version-5.0/picture/v5/observability/message-accumulation.png differ
diff --git a/versioned_docs/version-5.0/picture/v5/observability/pushconsumer-consumption.png b/versioned_docs/version-5.0/picture/v5/observability/pushconsumer-consumption.png
new file mode 100644
index 000000000..866c2b003
Binary files /dev/null and b/versioned_docs/version-5.0/picture/v5/observability/pushconsumer-consumption.png differ