org.apache.bookkeeper.stats.prometheus

Class PrometheusStatsLogger

java.lang.Object

org.apache.bookkeeper.stats.prometheus.PrometheusStatsLogger

All Implemented Interfaces:

StatsLogger

public class PrometheusStatsLogger
extends java.lang.Object
implements StatsLogger

A Prometheus based StatsLogger implementation.

Constructor Summary

Constructors

Constructor and Description
PrometheusStatsLogger(PrometheusMetricsProvider provider, java.lang.String scope)

Method Summary

Modifier and Type	Method and Description
Counter	getCounter(java.lang.String name)
OpStatsLogger	getOpStatsLogger(java.lang.String name)
<T extends java.lang.Number> void	registerGauge(java.lang.String name, Gauge<T> gauge) Register given gauge as name name.
void	removeScope(java.lang.String name, StatsLogger statsLogger) Remove the given statsLogger for scope name.
StatsLogger	scope(java.lang.String name) Provide the stats logger under scope name.
<T extends java.lang.Number> void	unregisterGauge(java.lang.String name, Gauge<T> gauge) Unregister given gauge from name name.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrometheusStatsLogger

PrometheusStatsLogger(PrometheusMetricsProvider provider,
                      java.lang.String scope)

Method Detail

getOpStatsLogger

public OpStatsLogger getOpStatsLogger(java.lang.String name)

Specified by:

getOpStatsLogger in interface StatsLogger

Parameters:

name - Stats Name

Returns:

Get the logger for an OpStat described by the name.

getCounter

public Counter getCounter(java.lang.String name)

Specified by:

getCounter in interface StatsLogger

Parameters:

name - Stats Name

Returns:

Get the logger for a simple stat described by the name

registerGauge

public <T extends java.lang.Number> void registerGauge(java.lang.String name,
                                                       Gauge<T> gauge)

Description copied from interface: StatsLogger

Register given gauge as name name.

Specified by:

registerGauge in interface StatsLogger

Parameters:

name - gauge name

gauge - gauge function

unregisterGauge

public <T extends java.lang.Number> void unregisterGauge(java.lang.String name,
                                                         Gauge<T> gauge)

Description copied from interface: StatsLogger

Unregister given gauge from name name.

Specified by:

unregisterGauge in interface StatsLogger

Parameters:

name - name of the gauge

gauge - gauge function

removeScope

public void removeScope(java.lang.String name,
                        StatsLogger statsLogger)

Description copied from interface: StatsLogger

Remove the given statsLogger for scope name. It can be no-op if the underlying stats provider doesn't have the ability to remove scope.

Specified by:

removeScope in interface StatsLogger

Parameters:

name - name of the scope

statsLogger - the stats logger of this scope.

scope

public StatsLogger scope(java.lang.String name)

Description copied from interface: StatsLogger

Provide the stats logger under scope name.

Specified by:

scope in interface StatsLogger

Parameters:

name - scope name.

Returns:

stats logger under scope name.