Package org.forgerock.monitoring.api.instrument

Class MeterRegistryHolder

java.lang.Object

org.forgerock.monitoring.api.instrument.MeterRegistryHolder

All Implemented Interfaces:

MeterRegistry

public final class MeterRegistryHolder
extends Object
implements MeterRegistry

Decorator for a meter registry. It can:

• prefix the dimensional metric names
• prefix the hierarchical metric names
• forward the metric creation to the decorated MeterRegistry

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.monitoring.api.instrument.MeterRegistry

MeterRegistry.Config, MeterRegistry.More

Constructor Summary

Constructors

Constructor	Description
MeterRegistryHolder(String dimensionalNamePrefix, MeterRegistry registry)	Constructor for this class.

Method Summary

Modifier and Type	Method	Description
MeterRegistry.Config	config()
Counter	counter(Meter.Id id)	Only used by Counter.builder(String).
void	deregisterAll()	Deregister all meters held by this object.
void	deregisterMatching(MeterFilter filter)	Deregister meters matching the provided filter.
<T> FunctionCounter	functionCounter(Meter.Id id, T obj, ToDoubleFunction<T> countFunction)	Only used by FunctionCounter.builder(String, Object, ToDoubleFunction).
<T> Gauge	gauge(Meter.Id id, T obj, ToDoubleFunction<T> valueFunction)	Only used by Gauge.builder(String, Object, ToDoubleFunction).
List<Meter>	getMeters()
MeterRegistryHolder	hierarchicalNamePrefix(String value)	Add a hierarchical name prefix for this MeterRegistryHolder.
MeterRegistry.More	more()	Access to less frequently used meter types and patterns.
Meter	register(Meter.Id id, Meter.Type type, Iterable<Measurement> measurements)	Register a custom meter type.
DistributionSummary	summary(Meter.Id id, HistogramConfig histogramConfig)	Only used by DistributionSummary.builder(String).
MeterRegistryHolder	tag(String key, String value)	Adds a tag that will be automatically added to all meters registered against this meter registry.
Timer	timer(Meter.Id id, HistogramConfig histogramConfig, PauseDetector pauseDetectorOverride)	Only used by Timer.builder(String).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.monitoring.api.instrument.MeterRegistry

find, forEachMeter, get

Constructor Details

MeterRegistryHolder

public MeterRegistryHolder(String dimensionalNamePrefix,
 MeterRegistry registry)

Constructor for this class.

Parameters:

dimensionalNamePrefix - prefix for the dimensional metric names. It will be used as a prefix for the hierarchical metric names unless a specific hierarchical name prefix is specified through hierarchicalNamePrefix(String).

registry - the decorated registry

Method Details

tag

public MeterRegistryHolder tag(String key,
 String value)

Adds a tag that will be automatically added to all meters registered against this meter registry.

Parameters:

key - the tag's key

value - the tag's value

Returns:

this meter registry

hierarchicalNamePrefix

public MeterRegistryHolder hierarchicalNamePrefix(String value)

Add a hierarchical name prefix for this MeterRegistryHolder.

Parameters:

value - the value for the hierarchical name

Returns:

this meter registry

counter

public Counter counter(Meter.Id id)

Description copied from interface: MeterRegistry

Only used by Counter.builder(String).

Specified by:

counter in interface MeterRegistry

Parameters:

id - The identifier for this counter.

Returns:

A new or existing counter.

functionCounter

public <T> FunctionCounter functionCounter(Meter.Id id,
 T obj,
 ToDoubleFunction<T> countFunction)

Description copied from interface: MeterRegistry

Only used by FunctionCounter.builder(String, Object, ToDoubleFunction).

Specified by:

functionCounter in interface MeterRegistry

Type Parameters:

T - The type of the object upon which the value function derives a measurement.

Parameters:

id - The id that uniquely identifies the function counter.

obj - The state object from which the count function derives a measurement.

countFunction - A monotonically increasing count function.

Returns:

A new function counter.

gauge

public <T> Gauge gauge(Meter.Id id,
 T obj,
 ToDoubleFunction<T> valueFunction)

Description copied from interface: MeterRegistry

Only used by Gauge.builder(String, Object, ToDoubleFunction).

Specified by:

gauge in interface MeterRegistry

Type Parameters:

T - The type of the state object from which the gauge value is extracted.

Parameters:

id - The identifier for this gauge.

obj - State object used to compute a value.

valueFunction - Function that is applied on the value for the number.

Returns:

A new or existing long task timer.

timer

public Timer timer(Meter.Id id,
 HistogramConfig histogramConfig,
 PauseDetector pauseDetectorOverride)

Description copied from interface: MeterRegistry

Only used by Timer.builder(String).

Specified by:

timer in interface MeterRegistry

Parameters:

id - The identifier for this timer.

histogramConfig - Configuration that governs how distribution statistics are computed.

Returns:

A new or existing timer.

summary

public DistributionSummary summary(Meter.Id id,
 HistogramConfig histogramConfig)

Description copied from interface: MeterRegistry

Only used by DistributionSummary.builder(String).

Specified by:

summary in interface MeterRegistry

Parameters:

id - The identifier for this distribution summary.

histogramConfig - Configuration that governs how distribution statistics are computed.

Returns:

A new or existing distribution summary.

register

public Meter register(Meter.Id id,
 Meter.Type type,
 Iterable<Measurement> measurements)

Description copied from interface: MeterRegistry

Register a custom meter type.

Specified by:

register in interface MeterRegistry

Parameters:

id - Id of the meter being registered.

type - Meter type, which may be used by naming conventions to normalize the name.

measurements - A sequence of measurements describing how to sample the meter.

Returns:

The registry.

deregisterMatching

public void deregisterMatching(MeterFilter filter)

Description copied from interface: MeterRegistry

Deregister meters matching the provided filter.

Specified by:

deregisterMatching in interface MeterRegistry

Parameters:

filter - a non-null meter filter

deregisterAll

public void deregisterAll()

Deregister all meters held by this object.

config

public MeterRegistry.Config config()

Specified by:

config in interface MeterRegistry

Returns:

A configuration object used to change the behavior of this registry.

more

public MeterRegistry.More more()

Description copied from interface: MeterRegistry

Access to less frequently used meter types and patterns.

Specified by:

more in interface MeterRegistry

Returns:

Access to additional meter types and patterns.

getMeters

public List<Meter> getMeters()

Specified by:

getMeters in interface MeterRegistry

Returns:

The set of registered meters.