Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add four new metric descriptions for Version 5.x #648

Merged
merged 13 commits into from
Jun 2, 2024
Merged

Add four new metric descriptions for Version 5.x #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5d46528
Add new committer sunxiaojian (#173)
sunxiaojian Aug 2, 2022
90ee595
Add committer hzh (#176)
hzh0425 Aug 4, 2022
1e6ecc6
Improve release manual, explicitly asking new release managers to add…
lizhanhui Aug 11, 2022
c48603a
copy old website code to develop
ShannonDing Sep 6, 2022
f29dff1
Add two metric rocketmq_create_topic_time and rocketmq_create_subscri…
May 27, 2024
257b7e3
Add two metric rocketmq_create_topic_time and rocketmq_create_subscri…
May 27, 2024
9c62235
Add two metric rocketmq_create_topic_time and rocketmq_create_subscri…
May 27, 2024
4fdfa25
Merge remote-tracking branch 'upstream/develop' into addm
May 30, 2024
fbc3d72
Merge remote-tracking branch 'origin/addm' into addm
May 31, 2024
31d00cd
Merge remote-tracking branch 'origin/addm' into addm
May 31, 2024
a5c222e
Merge remote-tracking branch 'origin/addm' into addm
May 31, 2024
b3c441b
Merge remote-tracking branch 'origin/addm' into addm
May 31, 2024
fdb8edf
Merge remote-tracking branch 'origin/addm' into addm
May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .asf.yaml
View file
Open in desktop
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
Open in desktop
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
Loading