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:46 UTC

[rocketmq-site] 02/02: Modified some error content for RocketMQ 5.x metrics definition.

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 消费场景