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
The following commit(s) were added to refs/heads/new-official-website by this
push:
new 3e242faba add doc about obtaining metrics (#527)
3e242faba is described below
commit 3e242faba1037f000e96571f76ed6650a88f21bf
Author: SSpirits <[email protected]>
AuthorDate: Wed Mar 8 14:10:30 2023 +0800
add doc about obtaining metrics (#527)
---
.../version-5.0/12-observability/01metrics.md | 116 ++++++++++-----
.../version-5.0/12-observability/01metrics.md | 165 +++++++++++++--------
2 files changed, 180 insertions(+), 101 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 81ab8f8cc..d213a384c 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
@@ -1,19 +1,21 @@
# Metrics
+
RocketMQ exposes the following metrics in Prometheus format. You can monitor
your clusters with those metrics.
- Broker metrics
- Producer metrics
- Consumer metrics
->Version support: The following metrics for RocketMQ were introduced since
5.1.0 and only support the broker.
-
+> Version support: The following metrics for RocketMQ were introduced since
5.1.0 and only support the broker.
## 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.
@@ -23,27 +25,26 @@ The following table describes the labels of the metrics
that are related to the
- 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 |
-
-
+| 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
|
### 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.
@@ -54,12 +55,12 @@ The following table describes the labels of the metrics
that are related to the
- 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 |
-| --- | ----- | --- | ---------- | --- |
+| 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.
@@ -67,32 +68,69 @@ The following table describes the labels of the metrics
that are related to the
- 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 |
-
+| 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 |
+<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.
+
+## How to Obtain Metrics
+
+Currently, two exporters are supported: gRPC OTLP and Prometheus.
+
+### gRPC OTLP Exporter
+
+The gRPC OTLP exporter periodically reports metrics to the specified
OpenTelemetry Collector.
+
+Prerequisites: Deploy an OpenTelemetry Collector that supports the [GRPC
OpenTelemetry
Protocol](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md).
+
+To enable the gRPC OTLP exporter of Broker metrics, do the following:
+
+1. Set `metricsExporterType` to `OTLP_GRPC`.
+2. Set `getMetricsGrpcExporterTarget` to the endpoint provided by the
OpenTelemetry Collector.
+
+Optional configurations:
+
+1. `metricsGrpcExporterHeader`: Attach request headers to the gRPC OTLP
exporter in the format of key1:value1,key2:value2.
+2. `metricGrpcExporterTimeOutInMills`: Set the request timeout for the gRPC
OTLP exporter.
+3. `metricGrpcExporterIntervalInMills`: Set the reporting interval for the
gRPC OTLP exporter.
+
+### Prometheus Exporter
+
+The Prometheus exporter only supports Pull mode and Cumulative aggregation.
See [OpenTelemetry Metrics Exporter -
Prometheus](https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/prometheus/)
for more information.
+
+To enable the Prometheus exporter of Broker metrics, do the following:
+
+1. Set `metricsExporterType` to `PROM`.
+
+Visit `http://<broker-ip>:5557/metrics` to view metrics. Configure service
discovery or manually configure a pull task in Prometheus to collect metrics.
+
+Optional configurations:
+
+1. `metricsPromExporterPort`: The port number on which Broker exposes the
metrics service. The default is `5557`.
+2. `metricGrpcExporterTimeOutInMills`: The hostname for the exposed metrics
service. The default is the IP to which Broker registers with NameServer,
brokerIP1.
diff --git a/versioned_docs/version-5.0/12-observability/01metrics.md
b/versioned_docs/version-5.0/12-observability/01metrics.md
index a71a066c5..04a5222ee 100644
--- a/versioned_docs/version-5.0/12-observability/01metrics.md
+++ b/versioned_docs/version-5.0/12-observability/01metrics.md
@@ -1,95 +1,136 @@
# Metrics
+
RocketMQ 以 Prometheus 格式公开以下指标。您可以使用这些指标监视您的集群。
-- 服务端Metrics指标
-- 生产者Metrics指标
-- 消费者Metrics指标
+- 服务端 Metrics 指标
+- 生产者 Metrics 指标
+- 消费者 Metrics 指标
->版本支持：以下指标 Metrics 是从 5.1.0 版本开始支持。
+> 版本支持：以下指标 Metrics 是从 5.1.0 版本开始支持。
-## Metrics指标详情
+## Metrics 指标详情
### Metric types
-消息队列RocketMQ版定义的Metrics完全兼容开源Prometheus的标准，提供的Metrics的类型为Counter、Gauge和Histogram。更多信息，请参见
[METRIC TYPES](https://prometheus.io/docs/concepts/metric_types/)。
-### 服务端Metrics指标
-消息队列RocketMQ版服务端相关Metrics指标中Label的说明如下：
+消息队列 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的主题。
+- 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_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的说明如下：
+| 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 指标
+
+消息队列 RocketMQ 版生产者相关 Metrics 指标中 Label 的说明如下：
+
- cluster: RocketMQ 集群名称。
-- node_type: 服务节点类型。枚举值包含proxy、broker、nameserver。
-- node_id: 服务节点ID。
-- topic: 消息队列RocketMQ的主题。
+- node_type: 服务节点类型。枚举值包含 proxy、broker、nameserver。
+- node_id: 服务节点 ID。
+- topic: 消息队列 RocketMQ 的主题。
- message_type: 消息类型。有以下类型:<br />Normal:普通消息;<br />FIFO:顺序消息;<br
/>Transaction:事务消息;<br />Delay:定时/延时消息.
-- client_id: 客户端ID。
+- 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 类型 | 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 指标
-### 消费者Metrics指标
-消息队列RocketMQ版消费者相关Metrics指标中Label的说明如下：
-- topic: 消息队列RocketMQ的主题。
-- consumer_group: 消费者分组ID。
-- client_id: 客户端ID。
-- invocation_status: 消费结果, 枚举值包含 success 和 failure。
+消息队列 RocketMQ 版消费者相关 Metrics 指标中 Label 的说明如下：
-| 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 |
+- 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指标.
+
+消息队列 RocketMQ 版主要基于以下业务场景定义 Metrics 指标.
### 消息堆积场景
-<br
/>上图表示指定主题的某一队列中各消息的状态，消息队列RocketMQ版将处于不同处理阶段的消息数量和耗时进行统计，这些指标可直接反映队列中消息的处理速率和堆积情况，通过观察这些指标可初步判断业务的消费是否异常。具体的指标含义和计算公式如下：
-| 名称 | 描述 | 计算公式 |
-| --- | --- | --- |
-| 处理中的消息（inflight messages） | 在消费者客户端正在处理，但客户端还未返回消费结果的消息。 |
最晚一条拉取消息的位点－最晚一条提交消息的位点 |
-| 已就绪消息（ready messages） | 消息在消息队列RocketMQ版服务端已就绪，对消费者可见可被消费的消息。 |
最大消费位点－最晚一条拉取消息的位点 |
-| 已就绪消息的就绪时间（ready time） | 普通消息、顺序消息：消息存储到服务端的时间。 <br /> 定时/延时消息：消息定时或延时结束的时间。
<br /> 事务消息：事务提交的时间。 | -- |
-| 已就绪消息的排队时间（ready message queue time）| 该时间反应消费者拉取消息的及时性。 | 当前时间－最早一条就绪消息的就绪时间
|
-| 消费处理滞后时间（consumer lag time） | 该时间反应消费者完成消息处理的及时性。 | 当前时间－最早一条未提交消息的就绪时间|
+<br
/>上图表示指定主题的某一队列中各消息的状态，消息队列 RocketMQ
版将处于不同处理阶段的消息数量和耗时进行统计，这些指标可直接反映队列中消息的处理速率和堆积情况，通过观察这些指标可初步判断业务的消费是否异常。具体的指标含义和计算公式如下：
+| 名称 | 描述
| 计算公式 |
+| ------------------------------------------------ |
---------------------------------------------------------------------------------------------------------------------------------
| ---------------------------------------------- |
+| 处理中的消息（inflight messages） | 在消费者客户端正在处理，但客户端还未返回消费结果的消息。
|
最晚一条拉取消息的位点－最晚一条提交消息的位点 |
+| 已就绪消息（ready messages） | 消息在消息队列 RocketMQ
版服务端已就绪，对消费者可见可被消费的消息。
| 最大消费位点－最晚一条拉取消息的位点 |
+| 已就绪消息的就绪时间（ready time） | 普通消息、顺序消息：消息存储到服务端的时间。 <br />
定时/延时消息：消息定时或延时结束的时间。 <br /> 事务消息：事务提交的时间。 | --
|
+| 已就绪消息的排队时间（ready message queue time） | 该时间反应消费者拉取消息的及时性。
|
当前时间－最早一条就绪消息的就绪时间 |
+| 消费处理滞后时间（consumer lag time） | 该时间反应消费者完成消息处理的及时性。
|
当前时间－最早一条未提交消息的就绪时间 |
### PushConsumer 消费场景
-在PushConsumer类型中，消息的实时处理能力是基于SDK内部的典型Reactor线程模型实现的。如下图所示，SDK内置了一个长轮询线程，先将消息异步拉取到SDK内置的缓存队列中，再分别提交到消费线程中，触发监听器执行本地消费逻辑。<br
/><br
/>在PushConsumer消费场景下，本地缓冲队列相关指标如下：
+
+在 PushConsumer 类型中，消息的实时处理能力是基于 SDK 内部的典型 Reactor 线程模型实现的。如下图所示，SDK
内置了一个长轮询线程，先将消息异步拉取到 SDK 内置的缓存队列中，再分别提交到消费线程中，触发监听器执行本地消费逻辑。<br
/><br />在
PushConsumer 消费场景下，本地缓冲队列相关指标如下：
- 本地缓冲队列中的消息量：本地缓冲队列中的消息总条数。
- 本地缓冲队列中的消息大小：本地缓冲队列中所有消息大小的总和。
- 消息等待处理时间：消息暂存在本地缓冲队列中的时间。
+## Metrics 指标获取方式
+
+目前支持 gRPC OTLP 和 Prometheus 两种 exporter
+
+### gRPC OTLP exporter
+
+gRPC OTLP exporter 会周期性地向指定的 OpenTelemetry Collector 上报 metrics
+
+前置条件：需要部署支持 [GRPC OpenTelemetry
Protocol](https://github.com/open-telemetry/oteps/blob/main/text/0035-opentelemetry-protocol.md)
的 OpenTelemetry Collector
+
+开启 Broker metrics 的 gRPC OTLP exporter 需要进行以下配置：
+
+1. 将 `metricsExporterType` 设置为 `OTLP_GRPC`
+2. 将 `getMetricsGrpcExporterTarget` 设置为 OpenTelemetry Collector 提供的 endpoint
+
+可选配置：
+
+1. `metricsGrpcExporterHeader`：为 gRPC OTLP exporter 附加请求头，格式为
key1:value1,key2:value2
+2. `metricGrpcExporterTimeOutInMills`：设置 gRPC OTLP exporter 的请求超时时间
+3. `metricGrpcExporterIntervalInMills`：设置 gRPC OTLP exporter 的上报间隔
+
+### Prometheus exporter
+
+Prometheus exporter 仅支持 Pull 模式和 Cumulative 聚合，详见 [OpenTelemetry Metrics
Exporter -
Prometheus](https://opentelemetry.io/docs/reference/specification/metrics/sdk_exporters/prometheus/)
+
+开启 Broker metrics 的 Prometheus exporter 需要进行以下配置：
+
+1. 将 `metricsExporterType` 设置为 `PROM`
+
+访问 `http://<broker-ip>:5557/metrics` 来查看 metrics，在 Prometheus
中配置服务发现或手动配置拉取任务即可采集 metrics
+
+可选配置：
+
+1. `metricsPromExporterPort`：Broker 暴露 metrics 服务的端口号，默认为 `5557`
+2. `metricGrpcExporterTimeOutInMills`：暴露 metrics 服务的主机名，默认为 Broker 向
NameServer 注册的地址，即 `brokerIP1`
