Pulsar Metrics

Pulsar exposes the following metrics in Prometheus format. You can monitor your clusters with those metrics.

• ZooKeeper
• BookKeeper
• Broker
• Pulsar Functions
• Connectors
• Proxy
• Pulsar SQL Worker
• Pulsar transaction

The following types of metrics are available:

• Counter: a cumulative metric that represents a single monotonically increasing counter. The value increases by default. You can reset the value to zero or restart your cluster.
• Gauge: a metric that represents a single numerical value that can arbitrarily go up and down.
• Histogram: a histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets.
• Summary: similar to a histogram, a summary samples observations (usually things like request durations and response sizes). While it also provides a total count of observations and a sum of all observed values, it calculates configurable quantiles over a sliding time window.

ZooKeeper

The ZooKeeper metrics are exposed under "/metrics" at port 8000. You can use a different port by configuring the metricsProvider.httpPort in conf/zookeeper.conf.

Server metrics

Name	Type	Description
znode_count	Gauge	The number of z-nodes stored.
approximate_data_size	Gauge	The approximate size of all of z-nodes stored.
num_alive_connections	Gauge	The number of currently lived connections.
watch_count	Gauge	The number of watchers registered.
ephemerals_count	Gauge	The number of ephemeral z-nodes.

Request metrics

Name	Type	Description
request_commit_queued	Counter	The total number of requests already committed by a particular server.
updatelatency	Summary	The update requests latency calculated in milliseconds.
readlatency	Summary	The read requests latency calculated in milliseconds.

BookKeeper

The BookKeeper metrics are exposed under "/metrics" at port 8000. You can change the port by updating prometheusStatsHttpPort in the bookkeeper.conf configuration file.

Server metrics

Name	Type	Description
bookie_SERVER_STATUS	Gauge	The server status for bookie server. 1: the bookie is running in writable mode. 0: the bookie is running in readonly mode.
bookkeeper_server_ADD_ENTRY_count	Counter	The total number of ADD_ENTRY requests received at the bookie. The success label is used to distinguish between successes and failures.
bookkeeper_server_READ_ENTRY_count	Counter	The total number of READ_ENTRY requests received at the bookie. The success label is used to distinguish between successes and failures.
bookie_WRITE_BYTES	Counter	The total number of bytes written to the bookie.
bookie_READ_BYTES	Counter	The total number of bytes read from the bookie.
bookkeeper_server_ADD_ENTRY_REQUEST	Summary	The summary of request latency of ADD_ENTRY requests at the bookie. The success label is used to distinguish between successes and failures.
bookkeeper_server_READ_ENTRY_REQUEST	Summary	The summary of request latency of READ_ENTRY requests at the bookie. The success label is used to distinguish between successes and failures.

Journal metrics

Name	Type	Description
bookie_journal_JOURNAL_SYNC_count	Counter	The total number of journal fsync operations happening at the bookie. The success label is used to distinguish between successes and failures.
bookie_journal_JOURNAL_QUEUE_SIZE	Gauge	The total number of requests pending in the journal queue.
bookie_journal_JOURNAL_FORCE_WRITE_QUEUE_SIZE	Gauge	The total number of force write (fsync) requests pending in the force-write queue.
bookie_journal_JOURNAL_CB_QUEUE_SIZE	Gauge	The total number of callbacks pending in the callback queue.
bookie_journal_JOURNAL_ADD_ENTRY	Summary	The summary of request latency of adding entries to the journal.
bookie_journal_JOURNAL_SYNC	Summary	The summary of fsync latency of syncing data to the journal disk.

Storage metrics

Name	Type	Description
bookie_ledgers_count	Gauge	The total number of ledgers stored in the bookie.
bookie_entries_count	Gauge	The total number of entries stored in the bookie.
bookie_write_cache_size	Gauge	The bookie write cache size (in bytes).
bookie_read_cache_size	Gauge	The bookie read cache size (in bytes).
bookie_DELETED_LEDGER_COUNT	Counter	The total number of ledgers deleted since the bookie has started.
bookie_ledger_writable_dirs	Gauge	The number of writable directories in the bookie.

Broker

The broker metrics are exposed under "/metrics/" at port 8080. You can change the port by updating webServicePort to a different port 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.

Namespace metrics

Namespace metrics are only exposed when exposeTopicLevelMetricsInPrometheus is set to false.

All the namespace metrics are labelled with the following labels:

• cluster: cluster=\$\{pulsar_cluster\}. \$\{pulsar_cluster\} is the cluster name that you configured in broker.conf.
• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.

Name	Type	Description
pulsar_topics_count	Gauge	The number of Pulsar topics of the namespace owned by this broker.
pulsar_subscriptions_count	Gauge	The number of Pulsar subscriptions of the namespace served by this broker.
pulsar_producers_count	Gauge	The number of active producers of the namespace connected to this broker.
pulsar_consumers_count	Gauge	The number of active consumers of the namespace connected to this broker.
pulsar_rate_in	Gauge	The total message rate of the namespace coming into this broker (messages/second).
pulsar_rate_out	Gauge	The total message rate of the namespace going out from this broker (messages/second).
pulsar_throughput_in	Gauge	The total throughput of the namespace coming into this broker (bytes/second).
pulsar_throughput_out	Gauge	The total throughput of the namespace going out from this broker (bytes/second).
pulsar_storage_size	Gauge	The total storage size of the topics in this namespace owned by this broker (bytes).
pulsar_storage_logical_size	Gauge	The storage size of topics in the namespace owned by the broker without replicas (in bytes).
pulsar_storage_backlog_size	Gauge	The total backlog size of the topics of this namespace owned by this broker (messages).
pulsar_storage_offloaded_size	Gauge	The total amount of the data in this namespace offloaded to the tiered storage (bytes).
pulsar_storage_write_rate	Gauge	The total message batches (entries) written to the storage for this namespace (message batches / second).
pulsar_storage_read_rate	Gauge	The total message batches (entries) read from the storage for this namespace (message batches / second).
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. Available thresholds: pulsar_storage_write_latency_le_0_5: <= 0.5ms pulsar_storage_write_latency_le_1: <= 1ms pulsar_storage_write_latency_le_5: <= 5ms pulsar_storage_write_latency_le_10: <= 10ms pulsar_storage_write_latency_le_20: <= 20ms pulsar_storage_write_latency_le_50: <= 50ms pulsar_storage_write_latency_le_100: <= 100ms pulsar_storage_write_latency_le_200: <= 200ms pulsar_storage_write_latency_le_1000: <= 1s pulsar_storage_write_latency_le_overflow: > 1s
pulsar_entry_size_le_*	Histogram	The entry rate of a namespace that the entry size is smaller with a given threshold. Available thresholds: pulsar_entry_size_le_128: <= 128 bytes pulsar_entry_size_le_512: <= 512 bytes pulsar_entry_size_le_1_kb: <= 1 KB pulsar_entry_size_le_2_kb: <= 2 KB pulsar_entry_size_le_4_kb: <= 4 KB pulsar_entry_size_le_16_kb: <= 16 KB pulsar_entry_size_le_100_kb: <= 100 KB pulsar_entry_size_le_1_mb: <= 1 MB pulsar_entry_size_le_overflow: > 1 MB

Topic metrics

Topic metrics are only exposed when exposeTopicLevelMetricsInPrometheus is set to true.

All the topic metrics are labelled with the following labels:

• cluster: cluster=\$\{pulsar_cluster\}. \$\{pulsar_cluster\} is the cluster name that you configured in broker.conf.
• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.
• topic: topic=\$\{pulsar_topic\}. \$\{pulsar_topic\} is the topic name.

Name	Type	Description
pulsar_subscriptions_count	Gauge	The number of Pulsar subscriptions of the topic served by this broker.
pulsar_producers_count	Gauge	The number of active producers of the topic connected to this broker.
pulsar_consumers_count	Gauge	The number of active consumers of the topic connected to this broker.
pulsar_rate_in	Gauge	The total message rate of the topic coming into this broker (messages/second).
pulsar_rate_out	Gauge	The total message rate of the topic going out from this broker (messages/second).
pulsar_throughput_in	Gauge	The total throughput of the topic coming into this broker (bytes/second).
pulsar_throughput_out	Gauge	The total throughput of the topic going out from this broker (bytes/second).
pulsar_storage_size	Gauge	The total storage size of the topics in this topic owned by this broker (bytes).
pulsar_storage_logical_size	Gauge	The storage size of topics in the namespace owned by the broker without replicas (in bytes).
pulsar_storage_backlog_size	Gauge	The total backlog size of the topics of this topic owned by this broker (messages).
pulsar_storage_offloaded_size	Gauge	The total amount of the data in this topic offloaded to the tiered storage (bytes).
pulsar_storage_backlog_quota_limit	Gauge	The total amount of the data in this topic that limit the backlog quota (bytes).
pulsar_storage_write_rate	Gauge	The total message batches (entries) written to the storage for this topic (message batches / second).
pulsar_storage_read_rate	Gauge	The total message batches (entries) read from the storage for this topic (message batches / second).
pulsar_subscription_delayed	Gauge	The total message batches (entries) are delayed for dispatching.
pulsar_storage_write_latency_le_*	Histogram	The entry rate of a topic that the storage write latency is smaller with a given threshold. Available thresholds: pulsar_storage_write_latency_le_0_5: <= 0.5ms pulsar_storage_write_latency_le_1: <= 1ms pulsar_storage_write_latency_le_5: <= 5ms pulsar_storage_write_latency_le_10: <= 10ms pulsar_storage_write_latency_le_20: <= 20ms pulsar_storage_write_latency_le_50: <= 50ms pulsar_storage_write_latency_le_100: <= 100ms pulsar_storage_write_latency_le_200: <= 200ms pulsar_storage_write_latency_le_1000: <= 1s pulsar_storage_write_latency_le_overflow: > 1s
pulsar_entry_size_le_*	Histogram	The entry rate of a topic that the entry size is smaller with a given threshold. Available thresholds: pulsar_entry_size_le_128: <= 128 bytes pulsar_entry_size_le_512: <= 512 bytes pulsar_entry_size_le_1_kb: <= 1 KB pulsar_entry_size_le_2_kb: <= 2 KB pulsar_entry_size_le_4_kb: <= 4 KB pulsar_entry_size_le_16_kb: <= 16 KB pulsar_entry_size_le_100_kb: <= 100 KB pulsar_entry_size_le_1_mb: <= 1 MB pulsar_entry_size_le_overflow: > 1 MB
pulsar_in_bytes_total	Counter	The total number of messages in bytes received for this topic.
pulsar_in_messages_total	Counter	The total number of messages received for this topic.
pulsar_out_bytes_total	Counter	The total number of messages in bytes read from this topic.
pulsar_out_messages_total	Counter	The total number of messages read from this topic.
pulsar_compaction_removed_event_count	Gauge	The total number of removed events of the compaction.
pulsar_compaction_succeed_count	Gauge	The total number of successes of the compaction.
pulsar_compaction_failed_count	Gauge	The total number of failures of the compaction.
pulsar_compaction_duration_time_in_mills	Gauge	The duration time of the compaction.
pulsar_compaction_read_throughput	Gauge	The read throughput of the compaction.
pulsar_compaction_write_throughput	Gauge	The write throughput of the compaction.
pulsar_compaction_latency_le_*	Histogram	The compaction latency with given quantile. Available thresholds: pulsar_compaction_latency_le_0_5: <= 0.5ms pulsar_compaction_latency_le_1: <= 1ms pulsar_compaction_latency_le_5: <= 5ms pulsar_compaction_latency_le_10: <= 10ms pulsar_compaction_latency_le_20: <= 20ms pulsar_compaction_latency_le_50: <= 50ms pulsar_compaction_latency_le_100: <= 100ms pulsar_compaction_latency_le_200: <= 200ms pulsar_compaction_latency_le_1000: <= 1s pulsar_compaction_latency_le_overflow: > 1s
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

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.

ManagedLedgerCache metrics

All the ManagedLedgerCache 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
pulsar_ml_cache_evictions	Gauge	The number of cache evictions during the last minute.
pulsar_ml_cache_inserted_entries_total	Counter	The number of entries inserted into the entry cache. Note that this metric is only available in Pulsar 2.9.4 and later versions.
pulsar_ml_cache_evicted_entries_total	Counter	The number of entries evicted from the entry cache. Note that this metric is only available in Pulsar 2.9.4 and later versions.
pulsar_ml_cache_entries	Gauge	The number of entries in the entry cache. Note that this metric is only available in Pulsar 2.9.4 and later versions.
pulsar_ml_cache_hits_rate	Gauge	The number of cache hits per second.
pulsar_ml_cache_hits_throughput	Gauge	The amount of data is retrieved from the cache in byte/s
pulsar_ml_cache_misses_rate	Gauge	The number of cache misses per second
pulsar_ml_cache_misses_throughput	Gauge	The amount of data is retrieved from the cache in byte/s
pulsar_ml_cache_pool_active_allocations	Gauge	The number of currently active allocations in direct arena
pulsar_ml_cache_pool_active_allocations_huge	Gauge	The number of currently active huge allocation in direct arena
pulsar_ml_cache_pool_active_allocations_normal	Gauge	The number of currently active normal allocations in direct arena
pulsar_ml_cache_pool_active_allocations_small	Gauge	The number of currently active small allocations in direct arena
pulsar_ml_cache_pool_allocated	Gauge	The total allocated memory of chunk lists in direct arena
pulsar_ml_cache_pool_used	Gauge	The total used memory of chunk lists in direct arena
pulsar_ml_cache_used_size	Gauge	The size in byte used to store the entries payloads
pulsar_ml_count	Gauge	The number of currently opened managed ledgers

ManagedLedger metrics

All the managedLedger 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.
• namespace: namespace=${pulsar_namespace}. ${pulsar_namespace} is the namespace name.
• quantile: quantile=${quantile}. Quantile is only for Histogram type metric, and represents the threshold for given Buckets.

Name	Type	Description
pulsar_ml_AddEntryBytesRate	Gauge	The bytes/s rate of messages added
pulsar_ml_AddEntryWithReplicasBytesRate	Gauge	The bytes/s rate of messages added with replicas
pulsar_ml_AddEntryErrors	Gauge	The number of addEntry requests that failed
pulsar_ml_AddEntryLatencyBuckets	Histogram	The latency of adding a ledger entry with a given quantile (threshold), including time spent on waiting in queue on the broker side Available quantile: quantile="0.0_0.5" is AddEntryLatency between (0.0ms, 0.5ms] quantile="0.5_1.0" is AddEntryLatency between (0.5ms, 1.0ms] quantile="1.0_5.0" is AddEntryLatency between (1ms, 5ms] quantile="5.0_10.0" is AddEntryLatency between (5ms, 10ms] quantile="10.0_20.0" is AddEntryLatency between (10ms, 20ms] quantile="20.0_50.0" is AddEntryLatency between (20ms, 50ms] quantile="50.0_100.0" is AddEntryLatency between (50ms, 100ms] quantile="100.0_200.0" is AddEntryLatency between (100ms, 200ms] quantile="200.0_1000.0" is AddEntryLatency between (200ms, 1s]
pulsar_ml_AddEntryLatencyBuckets_OVERFLOW	Gauge	The number of times the AddEntryLatency is longer than 1 second
pulsar_ml_AddEntryMessagesRate	Gauge	The msg/s rate of messages added
pulsar_ml_AddEntrySucceed	Gauge	The number of addEntry requests that succeeded
pulsar_ml_EntrySizeBuckets	Histogram	The added entry size of a ledger with a given quantile. Available quantile: quantile="0.0_128.0" is EntrySize between (0byte, 128byte] quantile="128.0_512.0" is EntrySize between (128byte, 512byte] quantile="512.0_1024.0" is EntrySize between (512byte, 1KB] quantile="1024.0_2048.0" is EntrySize between (1KB, 2KB] quantile="2048.0_4096.0" is EntrySize between (2KB, 4KB] quantile="4096.0_16384.0" is EntrySize between (4KB, 16KB] quantile="16384.0_102400.0" is EntrySize between (16KB, 100KB] quantile="102400.0_1232896.0" is EntrySize between (100KB, 1MB]
pulsar_ml_EntrySizeBuckets_OVERFLOW	Gauge	The number of times the EntrySize is larger than 1MB
pulsar_ml_LedgerSwitchLatencyBuckets	Histogram	The ledger switch latency with a given quantile. Available quantile: quantile="0.0_0.5" is EntrySize between (0ms, 0.5ms] quantile="0.5_1.0" is EntrySize between (0.5ms, 1ms] quantile="1.0_5.0" is EntrySize between (1ms, 5ms] quantile="5.0_10.0" is EntrySize between (5ms, 10ms] quantile="10.0_20.0" is EntrySize between (10ms, 20ms] quantile="20.0_50.0" is EntrySize between (20ms, 50ms] quantile="50.0_100.0" is EntrySize between (50ms, 100ms] quantile="100.0_200.0" is EntrySize between (100ms, 200ms] quantile="200.0_1000.0" is EntrySize between (200ms, 1000ms]
pulsar_ml_LedgerSwitchLatencyBuckets_OVERFLOW	Gauge	The number of times the ledger switch latency is longer than 1 second
pulsar_ml_LedgerAddEntryLatencyBuckets	Histogram	The latency for bookie client to persist a ledger entry from broker to BookKeeper service with a given quantile (threshold). Available quantile: quantile="0.0_0.5" is LedgerAddEntryLatency between (0.0ms, 0.5ms] quantile="0.5_1.0" is LedgerAddEntryLatency between (0.5ms, 1.0ms] quantile="1.0_5.0" is LedgerAddEntryLatency between (1ms, 5ms] quantile="5.0_10.0" is LedgerAddEntryLatency between (5ms, 10ms] quantile="10.0_20.0" is LedgerAddEntryLatency between (10ms, 20ms] quantile="20.0_50.0" is LedgerAddEntryLatency between (20ms, 50ms] quantile="50.0_100.0" is LedgerAddEntryLatency between (50ms, 100ms] quantile="100.0_200.0" is LedgerAddEntryLatency between (100ms, 200ms] quantile="200.0_1000.0" is LedgerAddEntryLatency between (200ms, 1s]
pulsar_ml_LedgerAddEntryLatencyBuckets_OVERFLOW	Gauge	The number of times the LedgerAddEntryLatency is longer than 1 second
pulsar_ml_MarkDeleteRate	Gauge	The rate of mark-delete ops/s
pulsar_ml_NumberOfMessagesInBacklog	Gauge	The number of backlog messages for all the consumers
pulsar_ml_ReadEntriesBytesRate	Gauge	The bytes/s rate of messages read
pulsar_ml_ReadEntriesErrors	Gauge	The number of readEntries requests that failed
pulsar_ml_ReadEntriesRate	Gauge	The msg/s rate of messages read
pulsar_ml_ReadEntriesSucceeded	Gauge	The number of readEntries requests that succeeded
pulsar_ml_StoredMessagesSize	Gauge	The total size of the messages in active ledgers (accounting for the multiple copies stored)

Managed cursor acknowledgment state

The acknowledgment state is persistent to the ledger first. When the acknowledgment state fails to be persistent to the ledger, they are persistent to ZooKeeper. To track the stats of acknowledgment, you can configure the metrics for the managed cursor.

All the cursor acknowledgment state metrics are labelled with the following labels:

• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.

• ledger_name: ledger_name=\$\{pulsar_ledger_name\}. \$\{pulsar_ledger_name\} is the ledger name.

• cursor_name: ledger_name=\$\{pulsar_cursor_name\}. \$\{pulsar_cursor_name\} is the cursor name.

Name	Type	Description
pulsar_ml_cursor_persistLedgerSucceed(namespace=", ledger_name="", cursor_name:")	Gauge	The number of acknowledgment states that is persistent to a ledger.
pulsar_ml_cursor_persistLedgerErrors(namespace="", ledger_name="", cursor_name:"")	Gauge	The number of ledger errors occurred when acknowledgment states fail to be persistent to the ledger.
pulsar_ml_cursor_persistZookeeperSucceed(namespace="", ledger_name="", cursor_name:"")	Gauge	The number of acknowledgment states that is persistent to ZooKeeper.
pulsar_ml_cursor_persistZookeeperErrors(namespace="", ledger_name="", cursor_name:"")	Gauge	The number of ledger errors occurred when acknowledgment states fail to be persistent to ZooKeeper.
pulsar_ml_cursor_nonContiguousDeletedMessagesRange(namespace="", ledger_name="", cursor_name:"")	Gauge	The number of non-contiguous deleted messages ranges.
pulsar_ml_cursor_writeLedgerSize(namespace="", ledger_name="", cursor_name:"")	Gauge	The size of write to ledger.
pulsar_ml_cursor_writeLedgerLogicalSize(namespace="", ledger_name="", cursor_name:"")	Gauge	The size of write to ledger (accounting for without replicas).
pulsar_ml_cursor_readLedgerSize(namespace="", ledger_name="", cursor_name:"")	Gauge	The size of read from ledger.

LoadBalancing metrics

All the loadbalancing 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
• metric: metric="loadBalancing".

Name	Type	Description
pulsar_lb_bandwidth_in_usage	Gauge	The broker bandwidth in usage
pulsar_lb_bandwidth_out_usage	Gauge	The broker bandwidth out usage
pulsar_lb_cpu_usage	Gauge	The broker cpu usage
pulsar_lb_directMemory_usage	Gauge	The broker process direct memory usage
pulsar_lb_memory_usage	Gauge	The broker process memory usage

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".

Name	Type	Description
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

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".

Name	Type	Description
pulsar_lb_bundles_split_count	Counter	The total count of bundle split in this leader broker

Subscription metrics

Subscription metrics are only exposed when exposeTopicLevelMetricsInPrometheus is set to true.

All the subscription 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.
• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.
• topic: topic=\$\{pulsar_topic\}. \$\{pulsar_topic\} is the topic name.
• subscription: subscription=\$\{subscription\}. \$\{subscription\} is the topic subscription name.

Name	Type	Description
pulsar_subscription_back_log	Gauge	The total backlog of a subscription (messages).
pulsar_subscription_delayed	Gauge	The total number of messages are delayed to be dispatched for a subscription (messages).
pulsar_subscription_msg_rate_redeliver	Gauge	The total message rate for message being redelivered (messages/second).
pulsar_subscription_unacked_messages	Gauge	The total number of unacknowledged messages of a subscription (messages).
pulsar_subscription_blocked_on_unacked_messages	Gauge	Indicate whether a subscription is blocked on unacknowledged messages or not. 1 means the subscription is blocked on waiting unacknowledged messages to be acked. 0 means the subscription is not blocked on waiting unacknowledged messages to be acked.
pulsar_subscription_msg_rate_out	Gauge	The total message dispatch rate for a subscription (messages/second).
pulsar_subscription_msg_throughput_out	Gauge	The total message dispatch throughput for a subscription (bytes/second).

Consumer metrics

Consumer metrics are only exposed when both exposeTopicLevelMetricsInPrometheus and exposeConsumerLevelMetricsInPrometheus are set to true.

All the consumer 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.
• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.
• topic: topic=\$\{pulsar_topic\}. \$\{pulsar_topic\} is the topic name.
• subscription: subscription=\$\{subscription\}. \$\{subscription\} is the topic subscription name.
• consumer_name: consumer_name=\$\{consumer_name\}. \$\{consumer_name\} is the topic consumer name.
• consumer_id: consumer_id=\$\{consumer_id\}. \$\{consumer_id\} is the topic consumer id.

Name	Type	Description
pulsar_consumer_msg_rate_redeliver	Gauge	The total message rate for message being redelivered (messages/second).
pulsar_consumer_unacked_messages	Gauge	The total number of unacknowledged messages of a consumer (messages).
pulsar_consumer_blocked_on_unacked_messages	Gauge	Indicate whether a consumer is blocked on unacknowledged messages or not. 1 means the consumer is blocked on waiting unacknowledged messages to be acked. 0 means the consumer is not blocked on waiting unacknowledged messages to be acked.
pulsar_consumer_msg_rate_out	Gauge	The total message dispatch rate for a consumer (messages/second).
pulsar_consumer_msg_throughput_out	Gauge	The total message dispatch throughput for a consumer (bytes/second).
pulsar_consumer_available_permits	Gauge	The available permits for for a consumer.

Managed ledger bookie client metrics

All the managed ledger bookie client 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
pulsar_managedLedger_client_bookkeeper_ml_scheduler_completed_tasks_*	Gauge	The number of tasks the scheduler executor execute completed. The number of metrics determined by the scheduler executor thread number configured by managedLedgerNumSchedulerThreads in broker.conf.
pulsar_managedLedger_client_bookkeeper_ml_scheduler_queue_*	Gauge	The number of tasks queued in the scheduler executor's queue. The number of metrics determined by scheduler executor's thread number configured by managedLedgerNumSchedulerThreads in broker.conf.
pulsar_managedLedger_client_bookkeeper_ml_scheduler_total_tasks_*	Gauge	The total number of tasks the scheduler executor received. The number of metrics determined by scheduler executor's thread number configured by managedLedgerNumSchedulerThreads in broker.conf.
pulsar_managedLedger_client_bookkeeper_ml_scheduler_task_execution	Summary	The scheduler task execution latency calculated in milliseconds.
pulsar_managedLedger_client_bookkeeper_ml_scheduler_task_queued	Summary	The scheduler task queued latency calculated in milliseconds.

Token metrics

All the token 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
pulsar_expired_token_count	Counter	The number of expired tokens in Pulsar.
pulsar_expiring_token_minutes	Histogram	The remaining time of expiring tokens in minutes.

Authentication metrics

All the authentication 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.
• provider_name: provider_name=\$\{provider_name\}. \$\{provider_name\} is the class name of the authentication provider.
• auth_method: auth_method=\$\{auth_method\}. \$\{auth_method\} is the authentication method of the authentication provider.
• reason: reason=\$\{reason\}. \$\{reason\} is the reason for failing authentication operation. (This label is only for pulsar_authentication_failures_count.)

Name	Type	Description
pulsar_authentication_success_count	Counter	The number of successful authentication operations.
pulsar_authentication_failures_count	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. 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:

• cluster: cluster=\$\{pulsar_cluster\}. \$\{pulsar_cluster\} is the cluster name that you have configured in the broker.conf file.
• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.

Name	Type	Description
pulsar_function_processed_successfully_total	Counter	The total number of messages processed successfully.
pulsar_function_processed_successfully_total_1min	Counter	The total number of messages processed successfully in the last 1 minute.
pulsar_function_system_exceptions_total	Counter	The total number of system exceptions.
pulsar_function_system_exceptions_total_1min	Counter	The total number of system exceptions in the last 1 minute.
pulsar_function_user_exceptions_total	Counter	The total number of user exceptions.
pulsar_function_user_exceptions_total_1min	Counter	The total number of user exceptions in the last 1 minute.
pulsar_function_process_latency_ms	Summary	The process latency in milliseconds.
pulsar_function_process_latency_ms_1min	Summary	The process latency in milliseconds in the last 1 minute.
pulsar_function_last_invocation	Gauge	The timestamp of the last invocation of the function.
pulsar_function_received_total	Counter	The total number of messages received from source.
pulsar_function_received_total_1min	Counter	The total number of messages received from source in the last 1 minute.
pulsar_function_user_metric_	Summary	The user-defined metrics.

Connectors

All the Pulsar connector 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.
• namespace: namespace=\$\{pulsar_namespace\}. \$\{pulsar_namespace\} is the namespace name.

Connector metrics contain source metrics and sink metrics.

• Source metrics

  Name	Type	Description
  pulsar_source_written_total	Counter	The total number of records written to a Pulsar topic.
  pulsar_source_written_total_1min	Counter	The total number of records written to a Pulsar topic in the last 1 minute.
  pulsar_source_received_total	Counter	The total number of records received from source.
  pulsar_source_received_total_1min	Counter	The total number of records received from source in the last 1 minute.
  pulsar_source_last_invocation	Gauge	The timestamp of the last invocation of the source.
  pulsar_source_source_exception	Gauge	The exception from a source.
  pulsar_source_source_exceptions_total	Counter	The total number of source exceptions.
  pulsar_source_source_exceptions_total_1min	Counter	The total number of source exceptions in the last 1 minute.
  pulsar_source_system_exception	Gauge	The exception from system code.
  pulsar_source_system_exceptions_total	Counter	The total number of system exceptions.
  pulsar_source_system_exceptions_total_1min	Counter	The total number of system exceptions in the last 1 minute.
  pulsar_source_user_metric_	Summary	The user-defined metrics.

• Sink metrics

  Name	Type	Description
  pulsar_sink_written_total	Counter	The total number of records processed by a sink.
  pulsar_sink_written_total_1min	Counter	The total number of records processed by a sink in the last 1 minute.
  pulsar_sink_received_total_1min	Counter	The total number of messages that a sink has received from Pulsar topics in the last 1 minute.
  pulsar_sink_received_total	Counter	The total number of records that a sink has received from Pulsar topics.
  pulsar_sink_last_invocation	Gauge	The timestamp of the last invocation of the sink.
  pulsar_sink_sink_exception	Gauge	The exception from a sink.
  pulsar_sink_sink_exceptions_total	Counter	The total number of sink exceptions.
  pulsar_sink_sink_exceptions_total_1min	Counter	The total number of sink exceptions in the last 1 minute.
  pulsar_sink_system_exception	Gauge	The exception from system code.
  pulsar_sink_system_exceptions_total	Counter	The total number of system exceptions.
  pulsar_sink_system_exceptions_total_1min	Counter	The total number of system exceptions in the last 1 minute.
  pulsar_sink_user_metric_	Summary	The user-defined metrics.

Proxy

All the proxy 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.
• kubernetes_pod_name: kubernetes_pod_name=\$\{kubernetes_pod_name\}. \$\{kubernetes_pod_name\} is the Kubernetes pod name.

Name	Type	Description
pulsar_proxy_active_connections	Gauge	Number of connections currently active in the proxy.
pulsar_proxy_new_connections	Counter	Counter of connections being opened in the proxy.
pulsar_proxy_rejected_connections	Counter	Counter for connections rejected due to throttling.
pulsar_proxy_binary_ops	Counter	Counter of proxy operations.
pulsar_proxy_binary_bytes	Counter	Counter of proxy bytes.

Pulsar SQL Worker

Name	Type	Description
split_bytes_read	Counter	Number of bytes read from BookKeeper.
split_num_messages_deserialized	Counter	Number of messages deserialized.
split_num_record_deserialized	Counter	Number of records deserialized.
split_bytes_read_per_query	Summary	Total number of bytes read per query.
split_entry_deserialize_time	Summary	Time spent on derserializing entries.
split_entry_deserialize_time_per_query	Summary	Time spent on derserializing entries per query.
split_entry_queue_dequeue_wait_time	Summary	Time spend on waiting to get entry from entry queue because it is empty.
split_entry_queue_dequeue_wait_time_per_query	Summary	Total time spent on waiting to get entry from entry queue per query.
split_message_queue_dequeue_wait_time_per_query	Summary	Time spent on waiting to dequeue from message queue because is is empty per query.
split_message_queue_enqueue_wait_time	Summary	Time spent on waiting for message queue enqueue because the message queue is full.
split_message_queue_enqueue_wait_time_per_query	Summary	Time spent on waiting for message queue enqueue because the message queue is full per query.
split_num_entries_per_batch	Summary	Number of entries per batch.
split_num_entries_per_query	Summary	Number of entries per query.
split_num_messages_deserialized_per_entry	Summary	Number of messages deserialized per entry.
split_num_messages_deserialized_per_query	Summary	Number of messages deserialized per query.
split_read_attempts	Summary	Number of read attempts (fail if queues are full).
split_read_attempts_per_query	Summary	Number of read attempts per query.
split_read_latency_per_batch	Summary	Latency of reads per batch.
split_read_latency_per_query	Summary	Total read latency per query.
split_record_deserialize_time	Summary	Time spent on deserializing message to record. For example, Avro, JSON, and so on.
split_record_deserialize_time_per_query	Summary	Time spent on deserializing message to record per query.
split_total_execution_time	Summary	The total execution time.

Pulsar transaction

All the transaction 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.
• coordinator_id: coordinator_id=\$\{coordinator_id\}. \$\{coordinator_id\} is the coordinator id.

Name	Type	Description
pulsar_txn_active_count	Gauge	Number of active transactions.
pulsar_txn_created_count	Counter	Number of created transactions.
pulsar_txn_committed_count	Counter	Number of committed transactions.
pulsar_txn_aborted_count	Counter	Number of aborted transactions of this coordinator.
pulsar_txn_timeout_count	Counter	Number of timeout transactions.
pulsar_txn_append_log_count	Counter	Number of append transaction logs.
pulsar_txn_execution_latency_le_*	Histogram	Transaction execution latency. Available latencies are as below: latency="10" is TransactionExecutionLatency between (0ms, 10ms] latency="20" is TransactionExecutionLatency between (10ms, 20ms] latency="50" is TransactionExecutionLatency between (20ms, 50ms] latency="100" is TransactionExecutionLatency between (50ms, 100ms] latency="500" is TransactionExecutionLatency between (100ms, 500ms] latency="1000" is TransactionExecutionLatency between (500ms, 1000ms] latency="5000" is TransactionExecutionLatency between (1s, 5s] latency="15000" is TransactionExecutionLatency between (5s, 15s] latency="30000" is TransactionExecutionLatency between (15s, 30s] latency="60000" is TransactionExecutionLatency between (30s, 60s] latency="300000" is TransactionExecutionLatency between (1m,5m] latency="1500000" is TransactionExecutionLatency between (5m,15m] latency="3000000" is TransactionExecutionLatency between (15m,30m] latency="overflow" is TransactionExecutionLatency between (30m,∞]