You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by li...@apache.org on 2022/12/08 02:13:40 UTC
[pulsar] branch master updated: [fix][doc] remove irrelevant components metrics links under broker section (#18691)
This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new c45f16cd844 [fix][doc] remove irrelevant components metrics links under broker section (#18691)
c45f16cd844 is described below
commit c45f16cd844334841f143979d39668c0c1fa25c3
Author: Eric Shen <er...@outlook.com>
AuthorDate: Thu Dec 8 10:13:33 2022 +0800
[fix][doc] remove irrelevant components metrics links under broker section (#18691)
---
site2/docs/reference-metrics.md | 100 +++++++-------------
.../version-2.10.x/reference-metrics.md | 76 ++++------------
.../version-2.8.x/reference-metrics.md | 66 +++-----------
.../version-2.9.x/reference-metrics.md | 101 +++++++++------------
4 files changed, 104 insertions(+), 239 deletions(-)
diff --git a/site2/docs/reference-metrics.md b/site2/docs/reference-metrics.md
index cbbca2cf03d..aae57bb94aa 100644
--- a/site2/docs/reference-metrics.md
+++ b/site2/docs/reference-metrics.md
@@ -12,6 +12,7 @@ Pulsar exposes the following metrics in Prometheus format. You can monitor your
* [BookKeeper](#bookkeeper)
* [Broker](#broker)
* [Pulsar Functions](#pulsar-functions)
+* [Connectors](#connectors)
* [Proxy](#proxy)
* [Pulsar SQL Worker](#pulsar-sql-worker)
* [Pulsar transaction](#pulsar-transaction)
@@ -117,42 +118,6 @@ in the `broker.conf` configuration file.
All the metrics exposed by a broker are labeled with `cluster=${pulsar_cluster}`. The name of Pulsar cluster is the value of `${pulsar_cluster}`, which you have configured in the `broker.conf` file.
-The following metrics are available for broker:
-
-- [ZooKeeper](#zookeeper)
- - [Server metrics](#server-metrics)
- - [Request metrics](#request-metrics)
-- [BookKeeper](#bookkeeper)
- - [Server metrics](#server-metrics-1)
- - [Journal metrics](#journal-metrics)
- - [Storage metrics](#storage-metrics)
- - [Replication metrics](#replication-metrics)
-- [Broker](#broker)
- - [Broker metrics](#broker-metrics)
- - [Namespace metrics](#namespace-metrics)
- - [Replication metrics](#replication-metrics)
- - [Topic metrics](#topic-metrics)
- - [Replication metrics](#replication-metrics-1)
- - [ManagedLedger metrics](#managedledger-metrics)
- - [LoadBalancing metrics](#loadbalancing-metrics)
- - [BundleUnloading metrics](#bundleunloading-metrics)
- - [BundleSplit metrics](#bundlesplit-metrics)
- - [Subscription metrics](#subscription-metrics)
- - [Consumer metrics](#consumer-metrics)
- - [Managed ledger bookie client metrics](#managed-ledger-bookie-client-metrics)
- - [Token metrics](#token-metrics)
- - [Authentication metrics](#authentication-metrics)
- - [Connection metrics](#connection-metrics)
- - [Jetty metrics](#jetty-metrics)
- - [Schema metrics](#schema-metrics)
- - [Offload metrics](#offload-metrics)
- - [Web service executor metrics](#web-service-executor-metrics)
- - [Metadata store metrics](#metadata-store-metrics)
-- [Pulsar Functions](#pulsar-functions)
-- [Proxy](#proxy)
-- [Pulsar SQL Worker](#pulsar-sql-worker)
-- [Pulsar transaction](#pulsar-transaction)
-
### Broker metrics
All the broker metrics are labeled with the following labels:
- cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} is the cluster name that you have configured in the `broker.conf` file.
@@ -225,24 +190,6 @@ All the namespace metrics are labeled with the following labels:
| 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). |
-#### Replication metrics
-
-If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-
-All the replication metrics are also labeled with `remoteCluster=${pulsar_remote_cluster}`.
-
-| Name | Type | Description |
-|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (message per second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (message per second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (byte per second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (byte per second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
-| pulsar_replication_rate_expired | Gauge | Total rate of messages expired (message per second). |
-| pulsar_replication_connected_count | Gauge | The count of replication-subscriber up and running to replicate to remote cluster. |
-| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time a message was produced to the time when it is about to be replicated. |
-
-
### Topic metrics
> Topic metrics are only exposed when `exposeTopicLevelMetricsInPrometheus` is set to `true`.
@@ -292,21 +239,24 @@ All the topic metrics are labeled with the following labels:
| 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. |
-#### Replication metrics
+### Replication metrics
-If a namespace that a topic belongs to is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
+If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-All the replication metrics are labeled with `remoteCluster=${pulsar_remote_cluster}`.
+All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
| Name | Type | Description |
|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the topic replicating from remote cluster (message per second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the topic replicating to remote cluster (message per second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the topic replicating from remote cluster (byte per second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the topic replicating to remote cluster (byte per second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the topic replicating to remote cluster (messages). |
+| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
+| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
+| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
+| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
+| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
+| pulsar_replication_rate_expired | Gauge | Total rate of messages expired (messages/second). |
+| pulsar_replication_connected_count | Gauge | The count of replication-subscriber up and running to replicate to remote cluster. |
+| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time a message was produced to the time when it is about to be replicated. |
-#### Topic lookup metrics
+### Topic lookup metrics
| Name | Type | Description |
|---|---|---|
@@ -384,7 +334,7 @@ All the loadbalancing metrics are labeled with the following labels:
| pulsar_lb_directMemory_usage | Gauge | The broker process direct memory usage (in percent). |
| pulsar_lb_memory_usage | Gauge | The broker process memory usage (in percent). |
-#### BundleUnloading metrics
+### BundleUnloading metrics
All the bundleUnloading metrics are labeled with the following labels:
- cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} is the cluster name that you have configured in the `broker.conf` file.
- metric: metric="bundleUnloading".
@@ -394,7 +344,7 @@ All the bundleUnloading metrics are labeled with the following labels:
| pulsar_lb_unload_broker_total | Counter | Unload broker count in this bundle unloading |
| pulsar_lb_unload_bundle_total | Counter | Bundle unload count in this bundle unloading |
-#### BundleSplit metrics
+### BundleSplit metrics
All the bundleUnloading metrics are labeled with the following labels:
- cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} is the cluster name that you have configured in the `broker.conf` file.
- metric: metric="bundlesSplit".
@@ -403,7 +353,7 @@ All the bundleUnloading metrics are labeled with the following labels:
|-------------------------------|---------|------------------------------------------------------------|
| pulsar_lb_bundles_split_total | Counter | The total count of bundle split in this leader broker |
-#### Bundle metrics
+### Bundle metrics
All the bundle metrics are labeled 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
@@ -518,6 +468,24 @@ All the authentication metrics are labeled with the following labels:
| pulsar_authentication_success_total| Counter | The number of successful authentication operations. |
| pulsar_authentication_failures_total | Counter | The number of failing authentication operations. |
+### Connection metrics
+
+All the connection 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=${advertised_address}`. `${advertised_address}` is the advertised address of the broker.
+- *metric*: `metric=${metric}`. `${metric}` is the connection metric collective name.
+
+| Name | Type | Description |
+|---|---|---|
+| pulsar_active_connections| Gauge | The number of active connections. |
+| pulsar_connection_created_total_count | Gauge | The total number of connections. |
+| pulsar_connection_create_success_count | Gauge | The number of successfully created connections. |
+| pulsar_connection_create_fail_count | Gauge | The number of failed connections. |
+| pulsar_connection_closed_total_count | Gauge | The total number of closed connections. |
+| pulsar_broker_throttled_connections | Gauge | The number of throttled connections. |
+| pulsar_broker_throttled_connections_global_limit | Gauge | The number of throttled connections because of per-connection limit. |
+
### Jetty metrics
> For a functions-worker running separately from brokers, its Jetty metrics are only exposed when `includeStandardPrometheusMetrics` is set to `true`.
diff --git a/site2/website/versioned_docs/version-2.10.x/reference-metrics.md b/site2/website/versioned_docs/version-2.10.x/reference-metrics.md
index e419908fb12..6739dda3355 100644
--- a/site2/website/versioned_docs/version-2.10.x/reference-metrics.md
+++ b/site2/website/versioned_docs/version-2.10.x/reference-metrics.md
@@ -13,6 +13,7 @@ Pulsar exposes the following metrics in Prometheus format. You can monitor your
* [BookKeeper](#bookkeeper)
* [Broker](#broker)
* [Pulsar Functions](#pulsar-functions)
+* [Connectors](#connectors)
* [Proxy](#proxy)
* [Pulsar SQL Worker](#pulsar-sql-worker)
* [Pulsar transaction](#pulsar-transaction)
@@ -82,37 +83,6 @@ in the `broker.conf` configuration file.
All the metrics exposed by a broker are labelled with `cluster=${pulsar_cluster}`. The name of Pulsar cluster is the value of `${pulsar_cluster}`, which you have configured in the `broker.conf` file.
-The following metrics are available for broker:
-
-- [ZooKeeper](#zookeeper)
- - [Server metrics](#server-metrics)
- - [Request metrics](#request-metrics)
-- [BookKeeper](#bookkeeper)
- - [Server metrics](#server-metrics-1)
- - [Journal metrics](#journal-metrics)
- - [Storage metrics](#storage-metrics)
-- [Broker](#broker)
- - [Namespace metrics](#namespace-metrics)
- - [Replication metrics](#replication-metrics)
- - [Topic metrics](#topic-metrics)
- - [Replication metrics](#replication-metrics-1)
- - [ManagedLedgerCache metrics](#managedledgercache-metrics)
- - [ManagedLedger metrics](#managedledger-metrics)
- - [LoadBalancing metrics](#loadbalancing-metrics)
- - [BundleUnloading metrics](#bundleunloading-metrics)
- - [BundleSplit metrics](#bundlesplit-metrics)
- - [Subscription metrics](#subscription-metrics)
- - [Consumer metrics](#consumer-metrics)
- - [Managed ledger bookie client metrics](#managed-ledger-bookie-client-metrics)
- - [Token metrics](#token-metrics)
- - [Authentication metrics](#authentication-metrics)
- - [Connection metrics](#connection-metrics)
- - [Jetty metrics](#jetty-metrics)
-- [Pulsar Functions](#pulsar-functions)
-- [Proxy](#proxy)
-- [Pulsar SQL Worker](#pulsar-sql-worker)
-- [Pulsar transaction](#pulsar-transaction)
-
### BookKeeper client metrics
All the BookKeeper client metric are labelled with the following label:
@@ -152,23 +122,6 @@ All the namespace metrics are labelled with the following labels:
| 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 [...]
-#### Replication metrics
-
-If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-
-All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
-
-| Name | Type | Description |
-|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
-| pulsar_replication_rate_expired | Gauge | Total rate of messages expired (messages/second). |
-| pulsar_replication_connected_count | Gauge | The count of replication-subscriber up and running to replicate to remote cluster. |
-| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time a message was produced to the time when it is about to be replicated. |
-
### Topic metrics
@@ -214,21 +167,24 @@ All the topic metrics are labelled with the following labels:
| 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. |
-#### Replication metrics
+### Replication metrics
-If a namespace that a topic belongs to is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
+If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-All the replication metrics are labelled with `remoteCluster=${pulsar_remote_cluster}`.
+All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
| Name | Type | Description |
|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the topic replicating from remote cluster (messages/second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the topic replicating to remote cluster (messages/second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the topic replicating from remote cluster (bytes/second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the topic replicating to remote cluster (bytes/second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the topic replicating to remote cluster (messages). |
+| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
+| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
+| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
+| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
+| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
+| pulsar_replication_rate_expired | Gauge | Total rate of messages expired (messages/second). |
+| pulsar_replication_connected_count | Gauge | The count of replication-subscriber up and running to replicate to remote cluster. |
+| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time a message was produced to the time when it is about to be replicated. |
-#### Topic lookup metrics
+### Topic lookup metrics
| Name | Type | Description |
|---|---|---|
@@ -326,7 +282,7 @@ All the loadbalancing metrics are labelled with the following labels:
| pulsar_lb_directMemory_usage | Gauge | The broker process direct memory usage (in percent). |
| pulsar_lb_memory_usage | Gauge | The broker process memory usage (in percent). |
-#### BundleUnloading metrics
+### BundleUnloading metrics
All the bundleUnloading 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.
- metric: metric="bundleUnloading".
@@ -336,7 +292,7 @@ All the bundleUnloading metrics are labelled with the following labels:
| pulsar_lb_unload_broker_count | Counter | Unload broker count in this bundle unloading |
| pulsar_lb_unload_bundle_count | Counter | Bundle unload count in this bundle unloading |
-#### BundleSplit metrics
+### BundleSplit metrics
All the bundleUnloading 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.
- metric: metric="bundlesSplit".
@@ -345,7 +301,7 @@ All the bundleUnloading metrics are labelled with the following labels:
| --- | --- | --- |
| pulsar_lb_bundles_split_count | Counter | bundle split count in this bundle splitting check interval |
-#### Bundle metrics
+### 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
diff --git a/site2/website/versioned_docs/version-2.8.x/reference-metrics.md b/site2/website/versioned_docs/version-2.8.x/reference-metrics.md
index 40732d8b554..4067b1ed193 100644
--- a/site2/website/versioned_docs/version-2.8.x/reference-metrics.md
+++ b/site2/website/versioned_docs/version-2.8.x/reference-metrics.md
@@ -13,6 +13,7 @@ Pulsar exposes the following metrics in Prometheus format. You can monitor your
* [BookKeeper](#bookkeeper)
* [Broker](#broker)
* [Pulsar Functions](#pulsar-functions)
+* [Connectors](#connectors)
* [Proxy](#proxy)
* [Pulsar SQL Worker](#pulsar-sql-worker)
* [Pulsar transaction](#pulsar-transaction)
@@ -76,37 +77,6 @@ in the `broker.conf` configuration file.
All the metrics exposed by a broker are labelled with `cluster=${pulsar_cluster}`. The name of Pulsar cluster is the value of `${pulsar_cluster}`, which you have configured in the `broker.conf` file.
-The following metrics are available for broker:
-
-- [ZooKeeper](#zookeeper)
- - [Server metrics](#server-metrics)
- - [Request metrics](#request-metrics)
-- [BookKeeper](#bookkeeper)
- - [Server metrics](#server-metrics-1)
- - [Journal metrics](#journal-metrics)
- - [Storage metrics](#storage-metrics)
-- [Broker](#broker)
- - [Namespace metrics](#namespace-metrics)
- - [Replication metrics](#replication-metrics)
- - [Topic metrics](#topic-metrics)
- - [Replication metrics](#replication-metrics-1)
- - [ManagedLedgerCache metrics](#managedledgercache-metrics)
- - [ManagedLedger metrics](#managedledger-metrics)
- - [LoadBalancing metrics](#loadbalancing-metrics)
- - [BundleUnloading metrics](#bundleunloading-metrics)
- - [BundleSplit metrics](#bundlesplit-metrics)
- - [Subscription metrics](#subscription-metrics)
- - [Consumer metrics](#consumer-metrics)
- - [Managed ledger bookie client metrics](#managed-ledger-bookie-client-metrics)
- - [Token metrics](#token-metrics)
- - [Authentication metrics](#authentication-metrics)
- - [Connection metrics](#connection-metrics)
- - [Jetty metrics](#jetty-metrics)
-- [Pulsar Functions](#pulsar-functions)
-- [Proxy](#proxy)
-- [Pulsar SQL Worker](#pulsar-sql-worker)
-- [Pulsar transaction](#pulsar-transaction)
-
### Namespace metrics
> Namespace metrics are only exposed when `exposeTopicLevelMetricsInPrometheus` is set to `false`.
@@ -136,20 +106,6 @@ All the namespace metrics are labelled with the following labels:
| 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 [...]
-#### Replication metrics
-
-If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-
-All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
-
-| Name | Type | Description |
-|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
-
### Topic metrics
> Topic metrics are only exposed when `exposeTopicLevelMetricsInPrometheus` is set to `true`.
@@ -193,19 +149,19 @@ All the topic metrics are labelled with the following labels:
| pulsar_compaction_compacted_entries_count | Gauge | The compacted entries count.<br />**Note:** This metric is only available in 2.8.1 and later versions. |
| pulsar_compaction_compacted_entries_size |Gauge | The compacted entries size.<br />**Note:** This metric is only available in 2.8.1 and later versions. |
-#### Replication metrics
+### Replication metrics
-If a namespace that a topic belongs to is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
+If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-All the replication metrics are labelled with `remoteCluster=${pulsar_remote_cluster}`.
+All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
| Name | Type | Description |
|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the topic replicating from remote cluster (messages/second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the topic replicating to remote cluster (messages/second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the topic replicating from remote cluster (bytes/second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the topic replicating to remote cluster (bytes/second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the topic replicating to remote cluster (messages). |
+| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
+| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
+| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
+| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
+| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
### ManagedLedgerCache metrics
All the ManagedLedgerCache metrics are labelled with the following labels:
@@ -294,7 +250,7 @@ All the loadbalancing metrics are labelled with the following labels:
| pulsar_lb_directMemory_usage | Gauge | The broker process direct memory usage (in percent). |
| pulsar_lb_memory_usage | Gauge | The broker process memory usage (in percent). |
-#### BundleUnloading metrics
+### BundleUnloading metrics
All the bundleUnloading 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.
- metric: metric="bundleUnloading".
@@ -304,7 +260,7 @@ All the bundleUnloading metrics are labelled with the following labels:
| pulsar_lb_unload_broker_count | Counter | Unload broker count in this bundle unloading |
| pulsar_lb_unload_bundle_count | Counter | Bundle unload count in this bundle unloading |
-#### BundleSplit metrics
+### BundleSplit metrics
All the bundleUnloading 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.
- metric: metric="bundlesSplit".
diff --git a/site2/website/versioned_docs/version-2.9.x/reference-metrics.md b/site2/website/versioned_docs/version-2.9.x/reference-metrics.md
index 08f3e99b780..ce6722da1c9 100644
--- a/site2/website/versioned_docs/version-2.9.x/reference-metrics.md
+++ b/site2/website/versioned_docs/version-2.9.x/reference-metrics.md
@@ -13,6 +13,7 @@ Pulsar exposes the following metrics in Prometheus format. You can monitor your
* [BookKeeper](#bookkeeper)
* [Broker](#broker)
* [Pulsar Functions](#pulsar-functions)
+* [Connectors](#connectors)
* [Proxy](#proxy)
* [Pulsar SQL Worker](#pulsar-sql-worker)
* [Pulsar transaction](#pulsar-transaction)
@@ -92,36 +93,6 @@ in the `broker.conf` configuration file.
All the metrics exposed by a broker are labelled with `cluster=${pulsar_cluster}`. The name of Pulsar cluster is the value of `${pulsar_cluster}`, which you have configured in the `broker.conf` file.
-The following metrics are available for broker:
-
-- [ZooKeeper](#zookeeper)
- - [Server metrics](#server-metrics)
- - [Request metrics](#request-metrics)
-- [BookKeeper](#bookkeeper)
- - [Server metrics](#server-metrics-1)
- - [Journal metrics](#journal-metrics)
- - [Storage metrics](#storage-metrics)
-- [Broker](#broker)
- - [Namespace metrics](#namespace-metrics)
- - [Replication metrics](#replication-metrics)
- - [Topic metrics](#topic-metrics)
- - [Replication metrics](#replication-metrics-1)
- - [ManagedLedgerCache metrics](#managedledgercache-metrics)
- - [ManagedLedger metrics](#managedledger-metrics)
- - [LoadBalancing metrics](#loadbalancing-metrics)
- - [BundleUnloading metrics](#bundleunloading-metrics)
- - [BundleSplit metrics](#bundlesplit-metrics)
- - [Subscription metrics](#subscription-metrics)
- - [Consumer metrics](#consumer-metrics)
- - [Managed ledger bookie client metrics](#managed-ledger-bookie-client-metrics)
- - [Token metrics](#token-metrics)
- - [Authentication metrics](#authentication-metrics)
- - [Connection metrics](#connection-metrics)
-- [Pulsar Functions](#pulsar-functions)
-- [Proxy](#proxy)
-- [Pulsar SQL Worker](#pulsar-sql-worker)
-- [Pulsar transaction](#pulsar-transaction)
-
### Namespace metrics
> Namespace metrics are only exposed when `exposeTopicLevelMetricsInPrometheus` is set to `false`.
@@ -151,24 +122,6 @@ All the namespace metrics are labelled with the following labels:
| 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 [...]
-#### Replication metrics
-
-If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-
-All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
-
-| Name | Type | Description |
-|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
-| pulsar_replication_rate_expired | Gauge | Total rate of messages expired (messages/second). |
-| pulsar_replication_connected_count | Gauge | The count of replication-subscriber up and running to replicate to remote cluster. |
-| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time a message was produced to the time when it is about to be replicated. |
-
-
### Topic metrics
> Topic metrics are only exposed when `exposeTopicLevelMetricsInPrometheus` is set to `true`.
@@ -212,19 +165,22 @@ All the topic metrics are labelled with the following labels:
| 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. |
-#### Replication metrics
+### Replication metrics
-If a namespace that a topic belongs to is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
+If a namespace is configured to be replicated among multiple Pulsar clusters, the corresponding replication metrics is also exposed when `replicationMetricsEnabled` is enabled.
-All the replication metrics are labelled with `remoteCluster=${pulsar_remote_cluster}`.
+All the replication metrics are also labelled with `remoteCluster=${pulsar_remote_cluster}`.
| Name | Type | Description |
|---|---|---|
-| pulsar_replication_rate_in | Gauge | The total message rate of the topic replicating from remote cluster (messages/second). |
-| pulsar_replication_rate_out | Gauge | The total message rate of the topic replicating to remote cluster (messages/second). |
-| pulsar_replication_throughput_in | Gauge | The total throughput of the topic replicating from remote cluster (bytes/second). |
-| pulsar_replication_throughput_out | Gauge | The total throughput of the topic replicating to remote cluster (bytes/second). |
-| pulsar_replication_backlog | Gauge | The total backlog of the topic replicating to remote cluster (messages). |
+| pulsar_replication_rate_in | Gauge | The total message rate of the namespace replicating from remote cluster (messages/second). |
+| pulsar_replication_rate_out | Gauge | The total message rate of the namespace replicating to remote cluster (messages/second). |
+| pulsar_replication_throughput_in | Gauge | The total throughput of the namespace replicating from remote cluster (bytes/second). |
+| pulsar_replication_throughput_out | Gauge | The total throughput of the namespace replicating to remote cluster (bytes/second). |
+| pulsar_replication_backlog | Gauge | The total backlog of the namespace replicating to remote cluster (messages). |
+| pulsar_replication_rate_expired | Gauge | Total rate of messages expired (messages/second). |
+| pulsar_replication_connected_count | Gauge | The count of replication-subscriber up and running to replicate to remote cluster. |
+| pulsar_replication_delay_in_seconds | Gauge | Time in seconds from the time a message was produced to the time when it is about to be replicated. |
### ManagedLedgerCache metrics
All the ManagedLedgerCache metrics are labelled with the following labels:
@@ -312,7 +268,7 @@ All the loadbalancing metrics are labelled with the following labels:
| pulsar_lb_directMemory_usage | Gauge | The broker process direct memory usage |
| pulsar_lb_memory_usage | Gauge | The broker process memory usage |
-#### BundleUnloading metrics
+### BundleUnloading metrics
All the bundleUnloading 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.
- metric: metric="bundleUnloading".
@@ -322,7 +278,7 @@ All the bundleUnloading metrics are labelled with the following labels:
| pulsar_lb_unload_broker_count | Counter | Unload broker count in this bundle unloading |
| pulsar_lb_unload_bundle_count | Counter | Bundle unload count in this bundle unloading |
-#### BundleSplit metrics
+### BundleSplit metrics
All the bundleUnloading 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.
- metric: metric="bundlesSplit".
@@ -431,6 +387,35 @@ All the connection metrics are labelled with the following labels:
| pulsar_broker_throttled_connections | Gauge | The number of throttled connections. |
| pulsar_broker_throttled_connections_global_limit | Gauge | The number of throttled connections because of per-connection limit. |
+### Jetty metrics
+
+> For a functions-worker running separately from brokers, its Jetty metrics are only exposed when `includeStandardPrometheusMetrics` is set to `true`.
+
+All the jetty 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.
+
+| Name | Type | Description |
+|---|---|---|
+| jetty_requests_total | Counter | Number of requests. |
+| jetty_requests_active | Gauge | Number of requests currently active. |
+| jetty_requests_active_max | Gauge | Maximum number of requests that have been active at once. |
+| jetty_request_time_max_seconds | Gauge | Maximum time spent handling requests. |
+| jetty_request_time_seconds_total | Counter | Total time spent in all request handling. |
+| jetty_dispatched_total | Counter | Number of dispatches. |
+| jetty_dispatched_active | Gauge | Number of dispatches currently active. |
+| jetty_dispatched_active_max | Gauge | Maximum number of active dispatches being handled. |
+| jetty_dispatched_time_max | Gauge | Maximum time spent in dispatch handling. |
+| jetty_dispatched_time_seconds_total | Counter | Total time spent in dispatch handling. |
+| jetty_async_requests_total | Counter | Total number of async requests. |
+| jetty_async_requests_waiting | Gauge | Currently waiting async requests. |
+| jetty_async_requests_waiting_max | Gauge | Maximum number of waiting async requests. |
+| jetty_async_dispatches_total | Counter | Number of requested that have been asynchronously dispatched. |
+| jetty_expires_total | Counter | Number of async requests that have expired. |
+| jetty_responses_total | Counter | Number of responses, labeled by status code. The `code` label can be "1xx", "2xx", "3xx", "4xx", or "5xx". |
+| jetty_stats_seconds | Gauge | Time in seconds stats have been collected for. |
+| jetty_responses_bytes_total | Counter | Total number of bytes across all responses. |
+
## Pulsar Functions
All the Pulsar Functions metrics are labelled with the following labels: