This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 61f163ea889 Add document for bucket delayed message tracker metrics
(#564)
61f163ea889 is described below
commit 61f163ea8892160688847b968684d8796285e0d6
Author: Cong Zhao <[email protected]>
AuthorDate: Mon May 22 17:42:43 2023 +0800
Add document for bucket delayed message tracker metrics (#564)
---
docs/reference-metrics.md | 20 ++++++++++++++++++--
versioned_docs/version-3.0.x/reference-metrics.md | 20 ++++++++++++++++++--
2 files changed, 36 insertions(+), 4 deletions(-)
diff --git a/docs/reference-metrics.md b/docs/reference-metrics.md
index e282065ed87..fcb05ea8486 100644
--- a/docs/reference-metrics.md
+++ b/docs/reference-metrics.md
@@ -201,7 +201,12 @@ All the namespace metrics are labeled with the following
labels:
| pulsar_subscription_delayed | Gauge | The total message batches (entries)
are delayed for dispatching. |
| pulsar_storage_write_latency_le_* | Histogram | The entry rate of a
namespace that the storage write latency is smaller with a given threshold.<br
/> Available thresholds: <br /><ul><li>pulsar_storage_write_latency_le_0_5: <=
0.5ms </li><li>pulsar_storage_write_latency_le_1: <=
1ms</li><li>pulsar_storage_write_latency_le_5: <=
5ms</li><li>pulsar_storage_write_latency_le_10: <=
10ms</li><li>pulsar_storage_write_latency_le_20: <=
20ms</li><li>pulsar_storage_write_latency_le_50: <= 50ms</ [...]
| pulsar_entry_size_le_* | Histogram | The entry rate of a namespace that the
entry size is smaller with a given threshold.<br /> Available thresholds: <br
/><ul><li>pulsar_entry_size_le_128: <= 128 bytes
</li><li>pulsar_entry_size_le_512: <= 512
bytes</li><li>pulsar_entry_size_le_1_kb: <= 1
KB</li><li>pulsar_entry_size_le_2_kb: <= 2
KB</li><li>pulsar_entry_size_le_4_kb: <= 4
KB</li><li>pulsar_entry_size_le_16_kb: <= 16
KB</li><li>pulsar_entry_size_le_100_kb: <= 100 KB</li><li>pulsar_ent [...]
-| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `InMemoryDelayedDeliveryTracker` of the namespace owned by this
broker (in bytes). |
+| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `DelayedDeliveryTracker` of the namespace owned by this broker (in
bytes). |
+| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed
message index buckets (immutable buckets + LastMutableBucket ) |
+| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed
message indexes for in the memory. |
+| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total
size of delayed message index bucket snapshot (in bytes). |
+| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of
operation delayed message index bucket snapshots. The `state` label can be
`succeed`,`failed`, and`all` (`all` means the total number of all states) and
the `type` label can be `create`,`load`,`delete`, and `merge`. |
+| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency
of delayed message index bucket snapshot operation with a given quantile
(threshold). The `type` label can be `create`,`load`,`delete`, and
`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation
latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between
(50ms, 100ms]</li><li>quantile="500" is operation latency between (100ms,
500ms]</li><li>quantile="1000" is operation l [...]
### Topic metrics
@@ -247,10 +252,15 @@ All the topic metrics are labeled with the following
labels:
| pulsar_compaction_latency_le_* | Histogram | The compaction latency with
given quantile. <br /> Available thresholds: <br
/><ul><li>pulsar_compaction_latency_le_0_5: <= 0.5ms
</li><li>pulsar_compaction_latency_le_1: <=
1ms</li><li>pulsar_compaction_latency_le_5: <=
5ms</li><li>pulsar_compaction_latency_le_10: <=
10ms</li><li>pulsar_compaction_latency_le_20: <=
20ms</li><li>pulsar_compaction_latency_le_50: <=
50ms</li><li>pulsar_compaction_latency_le_100: <= 100ms</li><li>pulsar_compact
[...]
| pulsar_compaction_compacted_entries_count | Gauge | The total number of the
compacted entries. |
| pulsar_compaction_compacted_entries_size |Gauge | The total size of the
compacted entries. |
-| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `InMemoryDelayedDeliveryTracker` of the topic owned by this broker
(in bytes). |
| pulsar_txn_tb_active_total | Gauge | The number of active transactions on
this topic. |
| pulsar_txn_tb_aborted_total | Counter | The number of aborted transactions
on the topic. |
| pulsar_txn_tb_committed_total | Counter | The number of committed
transactions on the topic. |
+| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `DelayedDeliveryTracker` of the topic owned by this broker (in
bytes). |
+| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed
message index buckets (immutable buckets + LastMutableBucket ) |
+| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed
message indexes for in the memory. |
+| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total
size of delayed message index bucket snapshot (in bytes). |
+| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of
operation delayed message index bucket snapshots. The `state` label can be
`succeed`,`failed`, and`all` (`all` means the total number of all states) and
the `type` label can be `create`,`load`,`delete`, and `merge`. |
+| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency
of delayed message index bucket snapshot operation with a given quantile
(threshold). The label`type` label can be `create`,`load`,`delete`, and
`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation
latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between
(50ms, 100ms]</li><li>quantile="500" is operation latency between (100ms,
500ms]</li><li>quantile="1000" is operat [...]
### Replication metrics
@@ -418,6 +428,12 @@ All the subscription metrics are labeled with the
following labels:
| pulsar_subscription_filter_accepted_msg_count | Counter | The number of
messages accepted by `EntryFilter`. |
| pulsar_subscription_filter_rejected_msg_count | Counter | The number of
messages rejected by `EntryFilter`. |
| pulsar_subscription_filter_rescheduled_msg_count | Counter | The number of
messages rescheduled by `EntryFilter`. |
+| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `DelayedDeliveryTracker` of the subscription owned by this broker
(in bytes). |
+| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed
message index buckets (immutable buckets + LastMutableBucket ) |
+| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed
message indexes for in the memory. |
+| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total
size of delayed message index bucket snapshot (in bytes). |
+| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of
operation delayed message index bucket snapshots. The `state` label can be
`succeed`,`failed`, and`all` (`all` means the total number of all states) and
the `type` label can be `create`,`load`,`delete`, and `merge`. |
+| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency
of delayed message index bucket snapshot operation with a given quantile
(threshold). The label`type` label can be `create`,`load`,`delete`, and
`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation
latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between
(50ms, 100ms]</li><li>quantile="500" is operation latency between (100ms,
500ms]</li><li>quantile="1000" is operat [...]
### Consumer metrics
diff --git a/versioned_docs/version-3.0.x/reference-metrics.md
b/versioned_docs/version-3.0.x/reference-metrics.md
index e282065ed87..fcb05ea8486 100644
--- a/versioned_docs/version-3.0.x/reference-metrics.md
+++ b/versioned_docs/version-3.0.x/reference-metrics.md
@@ -201,7 +201,12 @@ All the namespace metrics are labeled with the following
labels:
| pulsar_subscription_delayed | Gauge | The total message batches (entries)
are delayed for dispatching. |
| pulsar_storage_write_latency_le_* | Histogram | The entry rate of a
namespace that the storage write latency is smaller with a given threshold.<br
/> Available thresholds: <br /><ul><li>pulsar_storage_write_latency_le_0_5: <=
0.5ms </li><li>pulsar_storage_write_latency_le_1: <=
1ms</li><li>pulsar_storage_write_latency_le_5: <=
5ms</li><li>pulsar_storage_write_latency_le_10: <=
10ms</li><li>pulsar_storage_write_latency_le_20: <=
20ms</li><li>pulsar_storage_write_latency_le_50: <= 50ms</ [...]
| pulsar_entry_size_le_* | Histogram | The entry rate of a namespace that the
entry size is smaller with a given threshold.<br /> Available thresholds: <br
/><ul><li>pulsar_entry_size_le_128: <= 128 bytes
</li><li>pulsar_entry_size_le_512: <= 512
bytes</li><li>pulsar_entry_size_le_1_kb: <= 1
KB</li><li>pulsar_entry_size_le_2_kb: <= 2
KB</li><li>pulsar_entry_size_le_4_kb: <= 4
KB</li><li>pulsar_entry_size_le_16_kb: <= 16
KB</li><li>pulsar_entry_size_le_100_kb: <= 100 KB</li><li>pulsar_ent [...]
-| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `InMemoryDelayedDeliveryTracker` of the namespace owned by this
broker (in bytes). |
+| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `DelayedDeliveryTracker` of the namespace owned by this broker (in
bytes). |
+| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed
message index buckets (immutable buckets + LastMutableBucket ) |
+| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed
message indexes for in the memory. |
+| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total
size of delayed message index bucket snapshot (in bytes). |
+| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of
operation delayed message index bucket snapshots. The `state` label can be
`succeed`,`failed`, and`all` (`all` means the total number of all states) and
the `type` label can be `create`,`load`,`delete`, and `merge`. |
+| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency
of delayed message index bucket snapshot operation with a given quantile
(threshold). The `type` label can be `create`,`load`,`delete`, and
`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation
latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between
(50ms, 100ms]</li><li>quantile="500" is operation latency between (100ms,
500ms]</li><li>quantile="1000" is operation l [...]
### Topic metrics
@@ -247,10 +252,15 @@ All the topic metrics are labeled with the following
labels:
| pulsar_compaction_latency_le_* | Histogram | The compaction latency with
given quantile. <br /> Available thresholds: <br
/><ul><li>pulsar_compaction_latency_le_0_5: <= 0.5ms
</li><li>pulsar_compaction_latency_le_1: <=
1ms</li><li>pulsar_compaction_latency_le_5: <=
5ms</li><li>pulsar_compaction_latency_le_10: <=
10ms</li><li>pulsar_compaction_latency_le_20: <=
20ms</li><li>pulsar_compaction_latency_le_50: <=
50ms</li><li>pulsar_compaction_latency_le_100: <= 100ms</li><li>pulsar_compact
[...]
| pulsar_compaction_compacted_entries_count | Gauge | The total number of the
compacted entries. |
| pulsar_compaction_compacted_entries_size |Gauge | The total size of the
compacted entries. |
-| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `InMemoryDelayedDeliveryTracker` of the topic owned by this broker
(in bytes). |
| pulsar_txn_tb_active_total | Gauge | The number of active transactions on
this topic. |
| pulsar_txn_tb_aborted_total | Counter | The number of aborted transactions
on the topic. |
| pulsar_txn_tb_committed_total | Counter | The number of committed
transactions on the topic. |
+| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `DelayedDeliveryTracker` of the topic owned by this broker (in
bytes). |
+| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed
message index buckets (immutable buckets + LastMutableBucket ) |
+| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed
message indexes for in the memory. |
+| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total
size of delayed message index bucket snapshot (in bytes). |
+| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of
operation delayed message index bucket snapshots. The `state` label can be
`succeed`,`failed`, and`all` (`all` means the total number of all states) and
the `type` label can be `create`,`load`,`delete`, and `merge`. |
+| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency
of delayed message index bucket snapshot operation with a given quantile
(threshold). The label`type` label can be `create`,`load`,`delete`, and
`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation
latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between
(50ms, 100ms]</li><li>quantile="500" is operation latency between (100ms,
500ms]</li><li>quantile="1000" is operat [...]
### Replication metrics
@@ -418,6 +428,12 @@ All the subscription metrics are labeled with the
following labels:
| pulsar_subscription_filter_accepted_msg_count | Counter | The number of
messages accepted by `EntryFilter`. |
| pulsar_subscription_filter_rejected_msg_count | Counter | The number of
messages rejected by `EntryFilter`. |
| pulsar_subscription_filter_rescheduled_msg_count | Counter | The number of
messages rescheduled by `EntryFilter`. |
+| pulsar_delayed_message_index_size_bytes | Gauge | The total memory size
allocated by `DelayedDeliveryTracker` of the subscription owned by this broker
(in bytes). |
+| pulsar_delayed_message_index_bucket_total | Gauge | The number of delayed
message index buckets (immutable buckets + LastMutableBucket ) |
+| pulsar_delayed_message_index_loaded | Gauge | The total number of delayed
message indexes for in the memory. |
+| pulsar_delayed_message_index_bucket_snapshot_size_bytes | Gauge | The total
size of delayed message index bucket snapshot (in bytes). |
+| pulsar_delayed_message_index_bucket_op_count | Counter | The total number of
operation delayed message index bucket snapshots. The `state` label can be
`succeed`,`failed`, and`all` (`all` means the total number of all states) and
the `type` label can be `create`,`load`,`delete`, and `merge`. |
+| pulsar_delayed_message_index_bucket_op_latency_ms | Histogram | The latency
of delayed message index bucket snapshot operation with a given quantile
(threshold). The label`type` label can be `create`,`load`,`delete`, and
`merge`<br/>The label `quantile` can be:<ul><li>quantile="50" is operation
latency between (0ms, 50ms]</li><li>quantile="100" is operation latency between
(50ms, 100ms]</li><li>quantile="500" is operation latency between (100ms,
500ms]</li><li>quantile="1000" is operat [...]
### Consumer metrics
