Package org.forgerock.monitoring.api.instrument

Interface MeterRegistry.More

Enclosing interface:

MeterRegistry

public static interface MeterRegistry.More

Additional, less commonly used meter types.

Method Summary

Modifier and Type	Method	Description
<T> TimeGauge	timeGauge(String name, Iterable<Tag> tags, T obj, TimeUnit timeFunctionUnit, ToDoubleFunction<T> timeFunction)	A gauge that tracks a time value, to be scaled to the monitoring system's base time unit.
<T> TimeGauge	timeGauge(Meter.Id id, T obj, TimeUnit timeFunctionUnit, ToDoubleFunction<T> timeFunction)	A gauge that tracks a time value, to be scaled to the monitoring system's base time unit.

Method Detail

timeGauge

<T> TimeGauge timeGauge(String name,
                        Iterable<Tag> tags,
                        T obj,
                        TimeUnit timeFunctionUnit,
                        ToDoubleFunction<T> timeFunction)

A gauge that tracks a time value, to be scaled to the monitoring system's base time unit.

Parameters:

name - Name of the gauge being registered.

tags - Sequence of dimensions for breaking down the name.

obj - State object used to compute a value.

timeFunctionUnit - The base unit of time produced by the total time function.

timeFunction - Function that produces a time value from the state object. This value may increase and decrease over time.

Returns:

A new or existing time gauge.

timeGauge

<T> TimeGauge timeGauge(Meter.Id id,
                        T obj,
                        TimeUnit timeFunctionUnit,
                        ToDoubleFunction<T> timeFunction)

A gauge that tracks a time value, to be scaled to the monitoring system's base time unit.

Parameters:

id - The identifier for this time gauge.

obj - State object used to compute a value.

timeFunctionUnit - The base unit of time produced by the total time function.

timeFunction - Function that produces a time value from the state object. This value may increase and decrease over time.

Returns:

A new or existing time gauge.