This is an automated email from the ASF dual-hosted git repository.
bogong pushed a commit to branch branch-2.9
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/branch-2.9 by this push:
new cf92d1369a0 [docs] [ISSUE 12366] Add doc of bundles metrics (#12825)
cf92d1369a0 is described below
commit cf92d1369a081125a69d06d2a68a86478b46706f
Author: gaozhangmin <[email protected]>
AuthorDate: Mon Nov 22 09:35:00 2021 +0800
[docs] [ISSUE 12366] Add doc of bundles metrics (#12825)
* add docs
* fix typo
Co-authored-by: gavingaozhangmin <[email protected]>
(cherry picked from commit 051b60d7aed3409961d07734a3e92015292423ad)
---
site2/docs/reference-metrics.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/site2/docs/reference-metrics.md b/site2/docs/reference-metrics.md
index 9c9aa7a23cd..576189eb533 100644
--- a/site2/docs/reference-metrics.md
+++ b/site2/docs/reference-metrics.md
@@ -332,6 +332,23 @@ All the bundleUnloading metrics are labelled with the
following labels:
|-------------------------------|---------|------------------------------------------------------------|
| pulsar_lb_bundles_split_total | Counter | The total count of bundle split in
this leader broker |
+#### Bundle metrics
+All the bundle metrics are labelled with the following labels:
+- cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} is the cluster name
that you have configured in the `broker.conf` file.
+- broker: broker=${broker}. ${broker} is the IP address of the broker
+- bundle: bundle=${bundle}. ${bundle} is the bundle range on this broker
+- metric: metric="loadBalancing".
+
+| Name | Type | Description |
+| --- | --- | --- |
+| pulsar_bundle_msg_rate_in | Gauge | The total message rate coming into the
topics in this bundle (messages/second). |
+| pulsar_bundle_msg_rate_out | Gauge | The total message rate going out from
the topics in this bundle (messages/second). |
+| pulsar_bundle_topics_count | Gauge | The topic count in this bundle. |
+| pulsar_bundle_consumer_count | Gauge | The consumer count of the topics in
this bundle. |
+| pulsar_bundle_producer_count | Gauge | The producer count of the topics in
this bundle. |
+| pulsar_bundle_msg_throughput_in | Gauge | The total throughput coming into
the topics in this bundle (bytes/second). |
+| pulsar_bundle_msg_throughput_out | Gauge | The total throughput going out
from the topics in this bundle (bytes/second). |
+
### Subscription metrics
> Subscription metrics are only exposed when
> `exposeTopicLevelMetricsInPrometheus` is set to `true`.
