Pulsar Metrics

Pulsar 以 Prometheus 的格式暴露如下度量值。 你可以用这些度量值监视你的集群。

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

可以使用下列类型的度量值：

• Counter: 累计度量，代表一个单调递增的计数器。 值默认会增加。 你可以将值重置为零或重新启动你的集群。
• Gauge: 本指标代表一个可以随意增加或减少的数值。
• Histogram: 直方图样本观测 (通常是请求持续时间和响应大小) ，并将它们计入可配置的 bucket 中。
• Summary: 与直方图类似的总结样本观察 (通常是请求持续时间和响应大小)。 但它同时也提供了总观测次数以及所有观测值的总和，它会在滑动的时间窗口上计算可配置的分位数。

ZooKeeper

ZooKeeper 度量值会暴露在端口 8000 的 “/metrics”下。 你可以通过配置 stats_server_port 系统属性来使用不同的端口。

服务器度量值

请求度量值

BookKeeper

BookKeeper 度量值会暴露在端口 8000 的”/metrics”下。 你可以通过更新 bookkeeper.conf 配置文件中的 prometheusStatsHttpPort 来更改端口。

服务器度量值

日志度量值

存储度量值

Broker

broker 度量值会暴露在端口 8080 的”/metrics”下。 你可以通过更新 broker.conf 配置文件中的 webServicePort 来更改端口。

broker 暴露的所有度量值会带有 cluster=${pulsar_cluster} 标签。 Pulsar 集群的名称是 ${pulsar_cluster} 的值，也就是你在 broker.conf 文件中所设置的。

如下的度量值对 broker 可用：

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

命名空间度量值

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

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

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

复制度量值

如果一个命名空间被配置为在多个Pulsar集群中复制，当replicationMetricsEnabled 启用时，相应的复制度量值也会暴露出来。

所有的复制度量值也带有 remoteCluster=${pulsar_remote_cluster} 标签。

主题度量值

主题度量值只有在 exposeTopicLevelMetricsInPrometheus 被设为 true 时才暴露。

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

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

复制度量值

如果主题所属的命名空间被配置为在多个Pulsar集群中复制，当replicationMetricsEnabled 启用时，相应的复制度量值也会暴露出来。

所有的复制度量值带有 remoteCluster=${pulsar_remote_cluster} 标签。

ManagedLedgerCache 度量值

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

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

ManagedLedger 度量值

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

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• 命名空间: namespace=${pulsar_namespace}。 ${pulsar_namespace} 是命名空间名称。
• 分位数: quantile=${quantile}. 分位数是只提供给 直方图 的类型度量值，代表了给定 Bucket 的阈值。

LoadBalancing 度量值

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

• 集群: cluster=${pulsar_cluster}。 ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• broker: broker=${broker}. ${broker} 是 broker 的 IP 地址
• 度量值: metric=”loadBalancing”。

BundleUnloading 度量值

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

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

BundleSplit 度量值

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

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

Subscription metrics

订阅度量值只有在 exposeTopicLevelMetricsInPrometheus 被设为 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

消费者度量值只有当 exposeTopicLevelMetricsInPrometheus 和 exposeConsumerLevelMetricsInPrometheus 都设为 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 客户端度量值

所有的托管 ledger bookie 客户端度量值都带有以下标签：

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

Token metrics

All the token metrics are labelled with the following labels:

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

Authentication metrics

All the authentication metrics are labelled with the following labels:

• cluster: cluster=${pulsar_cluster}. ${pulsar_cluster} 就是你在 broker.conf 中配置的集群名称。
• 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.)

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