Pulsar Metrics

Pulsar exposes metrics in Prometheus format that can be collected and used for monitoring the health of the cluster.

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

概述

The metrics exposed by Pulsar are in Prometheus format. The types of metrics are:

• Counter: a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero on restart.
• Gauge: a gauge is a metric that represents a single numerical value that can arbitrarily go up and down.
• Histogram: 直方图样本观测 (通常是请求持续时间和响应大小) ，并将它们计入可配置的 bucket 中。
• Summary: 与直方图类似的总结样本观察 (通常是请求持续时间和响应大小)。 但它同时也提供了总观测次数以及所有观测值的总和，它会在滑动的时间窗口上计算可配置的分位数。

ZooKeeper

The ZooKeeper metrics are exposed under “/metrics” at port 8000. You can use a different port by configuring the stats_server_port system property.

服务器度量值

请求度量值

BookKeeper

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

服务器度量值

日志度量值

存储度量值

Broker

The broker metrics are exposed under “/metrics” at port 8080. You can change the port by updating webServicePort to a different port in broker.conf configuration file.

broker 暴露的所有度量值会带有 cluster=${pulsar_cluster} 标签。 The value of ${pulsar_cluster} is the pulsar cluster name you configured in broker.conf.

Broker has the following kinds of metrics:

• 命名空间度量值
  • 复制度量值
• 主题度量值
  • 复制度量值
• ManagedLedgerCache 度量值
• ManagedLedger 度量值
• LoadBalancing 度量值
  • BundleUnloading 度量值
  • BundleSplit 度量值
• Subscription metrics
• Consumer metrics
• ManagedLedger bookie 客户端度量值

命名空间度量值

命名空间度量值只有在 exposeTopicLevelMetricsInPrometheus 被设为 false 时才暴露。

所有命名空间度量值都带有以下标签：

• cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• namespace: namespace=${pulsar_namespace}. ${pulsar_namespace} 是命名空间名称。

复制度量值

If a namespace is configured to be replicated between multiple Pulsar clusters, the corresponding replication metrics will also be exposed when replicationMetricsEnabled is enabled.

All the replication metrics will also be labelled with remoteCluster=${pulsar_remote_cluster}.

主题度量值

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

所有主题度量值都带有以下标签：

• cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• namespace: namespace=${pulsar_namespace}. ${pulsar_namespace} 是命名空间名称。
• topic: topic=${pulsar_topic}. ${pulsar_topic} 是主题名。

复制度量值

If a namespace that a topic belongs to is configured to be replicated between multiple Pulsar clusters, the corresponding replication metrics will also be exposed when replicationMetricsEnabled is enabled.

All the replication metrics will also be labelled with remoteCluster=${pulsar_remote_cluster}.

ManagedLedgerCache 度量值

所有 ManagedLedgerCache 度量值都带有以下标签：

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} is the cluster name that you configured in broker.conf.

ManagedLedger 度量值

所有 managedLedger 度量值都带有以下标签：

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} is the cluster name that you configured in broker.conf.
• 命名空间: namespace=${pulsar_namespace}。 ${pulsar_namespace} 是命名空间名称。
• 分位数: quantile=${quantile}. 分位数是只提供给 直方图 的类型度量值，代表了给定 Bucket 的阈值。

LoadBalancing 度量值

所有负载均衡度量值都带有以下标签：

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} is the cluster name that you configured in broker.conf.
• broker: broker=${broker}. ${broker} is the ip address of the broker
• 度量值: metric=”loadBalancing”。

BundleUnloading 度量值

所有 bundleUnloading 度量值都带有以下标签：

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} is the cluster name that you configured in broker.conf.
• 度量值: metric=”bundleUnloading”。

BundleSplit 度量值

所有 bundleUnloading 度量值都带有以下标签：

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} is the cluster name that you configured in broker.conf.
• 度量值: metric=”bundlesSplit”。

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} 就是你在 broker.conf 中配置的集群名称。
• namespace: namespace=${pulsar_namespace}. ${pulsar_namespace} 是命名空间名称。
• topic: topic=${pulsar_topic}. ${pulsar_topic} 是主题名。
• subscription: subscription=${subscription}. ${subscription} is the topic subscription name.

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} 就是你在 broker.conf 中配置的集群名称。
• namespace: namespace=${pulsar_namespace}. ${pulsar_namespace} 是命名空间名称。
• topic: topic=${pulsar_topic}. ${pulsar_topic} 是主题名。
• 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.

托管的 ledger bookie 客户端度量值

All the managed ledger bookie client metrics labelled with the following labels:

• cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。

Pulsar Functions

所有 Pulsar Functions 度量值都带有以下标签：

• cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• namespace: namespace=${pulsar_namespace}. ${pulsar_namespace} 是命名空间名称。

Proxy

所有代理度量值都带有以下标签：

• cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• kubernetes_pod_name: kubernetes_pod_name=${kubernetes_pod_name}. ${kubernetes_pod_name} 是 kubernetes pod 名称。

Pulsar SQL Worker

Monitor

You can set up a Prometheus instance to collect all the metrics exposed at Pulsar components and set up Grafana dashboards to display the metrics and monitor your Pulsar cluster.

The following are some Grafana dashboards examples:

• pulsar-grafana: A grafana dashboard that displays metrics collected in Prometheus for Pulsar clusters running on Kubernetes.
• apache-pulsar-grafana-dashboard: A collection of grafana dashboard templates for different Pulsar components running on both Kubernetes and on-premise machines.