Package org.apache.zookeeper.metrics.prometheus

Class PrometheusMetricsProvider

java.lang.Object

org.apache.zookeeper.metrics.prometheus.PrometheusMetricsProvider

All Implemented Interfaces:

MetricsProvider

public class PrometheusMetricsProvider
extends Object
implements MetricsProvider

A Metrics Provider implementation based on https://prometheus.io.

Since:

3.6.0

Constructor Summary

Constructors

Constructor	Description
PrometheusMetricsProvider()

Method Summary

Modifier and Type	Method	Description
void	configure(Properties configuration)
void	dump(BiConsumer<String,Object> sink)	Dump all values to the 4lw interface and to the Admin server.
MetricsContext	getRootContext()
void	resetAllValues()
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusMetricsProvider

public PrometheusMetricsProvider()

Method Details

configure

public void configure(Properties configuration)
               throws MetricsProviderLifeCycleException

Specified by:

configure in interface MetricsProvider

Throws:

MetricsProviderLifeCycleException

start

public void start()
           throws MetricsProviderLifeCycleException

Specified by:

start in interface MetricsProvider

Throws:

MetricsProviderLifeCycleException

getRootContext

public MetricsContext getRootContext()

Specified by:

getRootContext in interface MetricsProvider

stop

public void stop()

Specified by:

stop in interface MetricsProvider

dump

public void dump(BiConsumer<String,Object> sink)

Dump all values to the 4lw interface and to the Admin server.

This method is not expected to be used to serve metrics to Prometheus. We are using the MetricsServlet provided by Prometheus for that, leaving the real representation to the Prometheus Java client.

Specified by:

dump in interface MetricsProvider

Parameters:

sink - the receiver of data (4lw interface, Admin server or tests)

resetAllValues

public void resetAllValues()

Specified by:

resetAllValues in interface MetricsProvider