Package org.apache.bookkeeper.stats.prometheus

Class PrometheusMetricsProvider

java.lang.Object

org.apache.bookkeeper.stats.prometheus.PrometheusMetricsProvider

All Implemented Interfaces:

StatsProvider

public class PrometheusMetricsProvider
extends Object
implements StatsProvider

A Prometheus based StatsProvider implementation.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final ConcurrentMap<ScopeContext,LongAdderCounter>	counters
static final String	DEFAULT_PROMETHEUS_STATS_HTTP_ADDR
static final boolean	DEFAULT_PROMETHEUS_STATS_HTTP_ENABLE
static final int	DEFAULT_PROMETHEUS_STATS_HTTP_PORT
static final int	DEFAULT_PROMETHEUS_STATS_LATENCY_ROLLOVER_SECONDS
(package private) final ConcurrentMap<ScopeContext,SimpleGauge<? extends Number>>	gauges
(package private) final ConcurrentMap<ScopeContext,DataSketchesOpStatsLogger>	opStats
static final String	PROMETHEUS_STATS_HTTP_ADDRESS
static final String	PROMETHEUS_STATS_HTTP_ENABLE
static final String	PROMETHEUS_STATS_HTTP_PORT
static final String	PROMETHEUS_STATS_LATENCY_ROLLOVER_SECONDS
(package private) final io.prometheus.client.CollectorRegistry	registry
(package private) org.eclipse.jetty.server.Server	server
(package private) final ConcurrentMap<ScopeContext,ThreadScopedLongAdderCounter>	threadScopedCounters
(package private) final ConcurrentMap<ScopeContext,ThreadScopedDataSketchesStatsLogger>	threadScopedOpStats

Constructor Summary

Constructors

Constructor	Description
PrometheusMetricsProvider()
PrometheusMetricsProvider(io.prometheus.client.CollectorRegistry registry)

Method Summary

Modifier and Type	Method	Description
StatsLogger	getStatsLogger(String scope)	Return the stats logger to a given scope.
String	getStatsName(String... statsComponents)	Return the fully qualified stats name comprised of given statsComponents.
(package private) void	rotateLatencyCollection()
void	start(org.apache.commons.configuration2.Configuration conf)	Initialize the stats provider by loading the given configuration conf.
void	stop()	Close the stats provider.
void	writeAllMetrics(Writer writer)

Methods inherited from class java.lang.Object

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

Field Details

PROMETHEUS_STATS_HTTP_ENABLE

public static final String PROMETHEUS_STATS_HTTP_ENABLE

See Also:

• Constant Field Values

DEFAULT_PROMETHEUS_STATS_HTTP_ENABLE

public static final boolean DEFAULT_PROMETHEUS_STATS_HTTP_ENABLE

See Also:

• Constant Field Values

PROMETHEUS_STATS_HTTP_ADDRESS

public static final String PROMETHEUS_STATS_HTTP_ADDRESS

See Also:

• Constant Field Values

DEFAULT_PROMETHEUS_STATS_HTTP_ADDR

public static final String DEFAULT_PROMETHEUS_STATS_HTTP_ADDR

See Also:

• Constant Field Values

PROMETHEUS_STATS_HTTP_PORT

public static final String PROMETHEUS_STATS_HTTP_PORT

See Also:

• Constant Field Values

DEFAULT_PROMETHEUS_STATS_HTTP_PORT

public static final int DEFAULT_PROMETHEUS_STATS_HTTP_PORT

See Also:

• Constant Field Values

PROMETHEUS_STATS_LATENCY_ROLLOVER_SECONDS

public static final String PROMETHEUS_STATS_LATENCY_ROLLOVER_SECONDS

See Also:

• Constant Field Values

DEFAULT_PROMETHEUS_STATS_LATENCY_ROLLOVER_SECONDS

public static final int DEFAULT_PROMETHEUS_STATS_LATENCY_ROLLOVER_SECONDS

See Also:

• Constant Field Values

registry

final io.prometheus.client.CollectorRegistry registry

server

org.eclipse.jetty.server.Server server

counters

final ConcurrentMap<ScopeContext,LongAdderCounter> counters

gauges

final ConcurrentMap<ScopeContext,SimpleGauge<? extends Number>> gauges

opStats

final ConcurrentMap<ScopeContext,DataSketchesOpStatsLogger> opStats

threadScopedOpStats

final ConcurrentMap<ScopeContext,ThreadScopedDataSketchesStatsLogger> threadScopedOpStats

threadScopedCounters

final ConcurrentMap<ScopeContext,ThreadScopedLongAdderCounter> threadScopedCounters

Constructor Details

PrometheusMetricsProvider

public PrometheusMetricsProvider()

PrometheusMetricsProvider

public PrometheusMetricsProvider(io.prometheus.client.CollectorRegistry registry)

Method Details

start

public void start(org.apache.commons.configuration2.Configuration conf)

Description copied from interface: StatsProvider

Initialize the stats provider by loading the given configuration conf.

Specified by:

start in interface StatsProvider

Parameters:

conf - Configuration to configure the stats provider.

stop

public void stop()

Description copied from interface: StatsProvider

Close the stats provider.

Specified by:

stop in interface StatsProvider

getStatsLogger

public StatsLogger getStatsLogger(String scope)

Description copied from interface: StatsProvider

Return the stats logger to a given scope.

Specified by:

getStatsLogger in interface StatsProvider

Parameters:

scope - Scope for the given stats

Returns:

stats logger for the given scope

writeAllMetrics

public void writeAllMetrics(Writer writer)
                     throws IOException

Specified by:

writeAllMetrics in interface StatsProvider

Throws:

IOException

getStatsName

public String getStatsName(String... statsComponents)

Description copied from interface: StatsProvider

Return the fully qualified stats name comprised of given statsComponents.

Specified by:

getStatsName in interface StatsProvider

Parameters:

statsComponents - stats components to comprise the fully qualified stats name

Returns:

the fully qualified stats name

rotateLatencyCollection

void rotateLatencyCollection()