Skip to content

Commit

Permalink
Add four new metric descriptions for Version 5.x (#648)
Browse files Browse the repository at this point in the history 
* 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: 黄梓淇 <[email protected]>

* Add two metric rocketmq_create_topic_time and rocketmq_create_subscription_time

Signed-off-by: 黄梓淇 <[email protected]>

---------

Signed-off-by: 黄梓淇 <[email protected]>
Co-authored-by: xiaoyi <[email protected]>
Co-authored-by: hzh0425 <[email protected]>
Co-authored-by: Li Zhanhui <[email protected]>
Co-authored-by: ShannonDing <[email protected]>
Co-authored-by: 黄梓淇 <[email protected]>
  • Loading branch information
@Stephanie0002 @sunxiaojian
@hzh0425 @lizhanhui @ShannonDing
6 people authored Jun 2, 2024
1 parent 7063e39 commit 7c7fda0
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 38 deletions.
4 changes: 2 additions & 2 deletions .asf.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ github:
- rocketmq
- java
- hacktoberfest

notifications:
commits: [email protected]
issues: [email protected]
pullrequests: [email protected]
jobs: [email protected]
discussions: [email protected]
discussions: [email protected]
43 changes: 24 additions & 19 deletions i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 |
| --------- | --------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ |
Expand Down
Loading

0 comments on commit 7c7fda0

Please sign in to comment.