This is an automated email from the ASF dual-hosted git repository. jinrongtong pushed a commit to branch new-official-website in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
The following commit(s) were added to refs/heads/new-official-website by this
push:
new 7c7fda06dc Add four new metric descriptions for Version 5.x (#648)
7c7fda06dc is described below
commit 7c7fda06dc562e387654448083ead37c16fd5e10
Author: Stephanie0002 <55239858+stephanie0...@users.noreply.github.com>
AuthorDate: Sun Jun 2 20:27:54 2024 +0800
Add four new metric descriptions for Version 5.x (#648)
* Add new committer sunxiaojian (#173)
* Add new committer styletang
* Add new committer sunxiaojian
* Add committer hzh (#176)
* 'add_top_contributor'
* 'modify_pic'
* modify
* Improve release manual, explicitly asking new release managers to add
his/her keys to both dev and release KEYS files; Correct other spell issues and
expressions
* copy old website code to develop
* Add two metric rocketmq_create_topic_time and
rocketmq_create_subscription_time
* Add two metric rocketmq_create_topic_time and
rocketmq_create_subscription_time
Signed-off-by: 黄梓淇 <me@U-0MV57FM9-2309.local>
* Add two metric rocketmq_create_topic_time and
rocketmq_create_subscription_time
Signed-off-by: 黄梓淇 <me@U-0MV57FM9-2309.local>
---------
Signed-off-by: 黄梓淇 <me@U-0MV57FM9-2309.local>
Co-authored-by: xiaoyi <sunxiaojian...@163.com>
Co-authored-by: hzh0425 <642256...@qq.com>
Co-authored-by: Li Zhanhui <lizhan...@gmail.com>
Co-authored-by: ShannonDing <libya_...@163.com>
Co-authored-by: 黄梓淇 <me@U-0MV57FM9-2309.local>
---
.asf.yaml | 4 +-
.../version-5.0/12-observability/01metrics.md | 43 ++++++++++++----------
.../version-5.0/12-observability/01metrics.md | 40 +++++++++++---------
3 files changed, 49 insertions(+), 38 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 2e75054ef4..bfb09d37fe 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -26,10 +26,10 @@ github:
- rocketmq
- java
- hacktoberfest
-
+
notifications:
commits: commits@rocketmq.apache.org
issues: commits@rocketmq.apache.org
pullrequests: commits@rocketmq.apache.org
jobs: commits@rocketmq.apache.org
- discussions: d...@rocketmq.apache.org
+ discussions: d...@rocketmq.apache.org
\ No newline at end of file
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 a01272af24..d12289b1a0 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
@@ -24,24 +24,29 @@ The following table describes the labels of the metrics
that are related to the
- 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_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
|
+- invocation_status: the result of the API call for create topic or consumer
group, which includes success and failure.
+
+| 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_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 |
+| histogram | rocketmq_topic_create_execution_time | millisecond |
The execution time for creating topic: <br />le_10_ms<br />le_100_ms<br
/>le_1_s<br />le_3_s<br />le_5_s<br />le_overflow
|
cluster,node_type,node_id,invocation_status,is_system |
+| histogram | rocketmq_consumer_group_create_execution_time | millisecond |
The execution time for creating consumer group: <br />le_10_ms<br
/>le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br />le_overflow
|
cluster,node_type,node_id,invocation_status |
+| gauge | rocketmq_topic_number | count |
The number of topics
| cluster,node_type,node_id
|
+| gauge | rocketmq_consumer_group_number | count |
The number of consumer group
| cluster,node_type,node_id
|
### Producer metrics
@@ -66,7 +71,7 @@ The following table describes the labels of the metrics that
are related to the
- 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.
+- invocation_status: the result of the API call for consuming messages, which
includes success and failure.
| Type | Name | Unit | Description
| Label |
| --------- | --------------------------------- | ----------- |
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| ------------------------------------------------ |
diff --git a/versioned_docs/version-5.0/12-observability/01metrics.md
b/versioned_docs/version-5.0/12-observability/01metrics.md
index 732c73360e..a16a983bc7 100644
--- a/versioned_docs/version-5.0/12-observability/01metrics.md
+++ b/versioned_docs/version-5.0/12-observability/01metrics.md
@@ -24,24 +24,30 @@ RocketMQ 以 Prometheus 格式公开以下指标。您可以使用这些指标
- topic: 消息队列 RocketMQ 的主题。
- message_type: 消息类型。有以下类型:<br />Normal:普通消息;<br />FIFO:顺序消息;<br
/>Transaction:事务消息;<br />Delay:定时/延时消息.
- consumer_group: 消费者 ID。
+- invocation_status: 创建主题或消费者组接口调用结果，枚举值包含 success 和 failure。
+
+| 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_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
|
+| histogram | rocketmq_topic_create_execution_time | millisecond |
创建主题执行耗时：<br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br
/>le_overflow
| cluster,node_type,node_id,invocation_status,is_system
|
+| histogram | rocketmq_consumer_group_create_execution_time | millisecond |
创建消费者组执行耗时：<br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br
/>le_overflow
| cluster,node_type,node_id,invocation_status
|
+| gauge | rocketmq_topic_number | count |
主题数量
| cluster,node_type,node_id
|
+| gauge | rocketmq_consumer_group_number | count |
消费者组数量
| cluster,node_type,node_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_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 指标
