org.apache.pulsar.broker.stats.prometheus

Class PrometheusMetricsGenerator

java.lang.Object

org.apache.pulsar.broker.stats.prometheus.PrometheusMetricsGenerator

public class PrometheusMetricsGenerator
extends Object

Generate metrics aggregated at the namespace level and optionally at a topic level and formats them out in a text format suitable to be consumed by Prometheus. Format specification can be found at https://prometheus.io/docs/instrumenting/exposition_formats/

Constructor Summary

Constructors

Constructor and Description
PrometheusMetricsGenerator()

Method Summary

Modifier and Type	Method and Description
static void	generate(PulsarService pulsar, boolean includeTopicMetrics, boolean includeConsumerMetrics, boolean includeProducerMetrics, boolean splitTopicAndPartitionIndexLabel, OutputStream out)
static void	generate(PulsarService pulsar, boolean includeTopicMetrics, boolean includeConsumerMetrics, boolean includeProducerMetrics, boolean splitTopicAndPartitionIndexLabel, OutputStream out, List<PrometheusRawMetricsProvider> metricsProviders)
static void	generate(PulsarService pulsar, boolean includeTopicMetrics, boolean includeConsumerMetrics, boolean includeProducerMetrics, OutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrometheusMetricsGenerator

public PrometheusMetricsGenerator()

Method Detail

generate

public static void generate(PulsarService pulsar,
                            boolean includeTopicMetrics,
                            boolean includeConsumerMetrics,
                            boolean includeProducerMetrics,
                            OutputStream out)
                     throws IOException

Throws:

IOException

generate

public static void generate(PulsarService pulsar,
                            boolean includeTopicMetrics,
                            boolean includeConsumerMetrics,
                            boolean includeProducerMetrics,
                            boolean splitTopicAndPartitionIndexLabel,
                            OutputStream out)
                     throws IOException

Throws:

IOException

generate

public static void generate(PulsarService pulsar,
                            boolean includeTopicMetrics,
                            boolean includeConsumerMetrics,
                            boolean includeProducerMetrics,
                            boolean splitTopicAndPartitionIndexLabel,
                            OutputStream out,
                            List<PrometheusRawMetricsProvider> metricsProviders)
                     throws IOException

Throws:

IOException