Package org.apache.pulsar.broker.stats.prometheus

Class PrometheusMetricsGenerator

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable

public class PrometheusMetricsGenerator
extends Object
implements AutoCloseable

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 Exposition Formats

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusMetricsGenerator.MetricsBuffer
static class	PrometheusMetricsGenerator.ResponseBuffer	A wraps the response buffer and asynchronously provides a gzip compressed buffer when requested.

Constructor Summary

Constructors

Constructor	Description
PrometheusMetricsGenerator(PulsarService pulsar, boolean includeTopicMetrics, boolean includeConsumerMetrics, boolean includeProducerMetrics, boolean splitTopicAndPartitionIndexLabel, Clock clock)

Method Summary

Modifier and Type	Method	Description
void	close()
protected io.netty.buffer.ByteBuf	generateMetrics(List<PrometheusRawMetricsProvider> metricsProviders)
PrometheusMetricsGenerator.MetricsBuffer	renderToBuffer(Executor executor, List<PrometheusRawMetricsProvider> metricsProviders)

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusMetricsGenerator

public PrometheusMetricsGenerator(PulsarService pulsar,
 boolean includeTopicMetrics,
 boolean includeConsumerMetrics,
 boolean includeProducerMetrics,
 boolean splitTopicAndPartitionIndexLabel,
 Clock clock)

Method Details

generateMetrics

protected io.netty.buffer.ByteBuf generateMetrics(List<PrometheusRawMetricsProvider> metricsProviders)

renderToBuffer

public PrometheusMetricsGenerator.MetricsBuffer renderToBuffer(Executor executor,
 List<PrometheusRawMetricsProvider> metricsProviders)

close

public void close()

Specified by:

close in interface AutoCloseable