io.micrometer.core.instrument

Interface Gauge

All Superinterfaces:

Meter

All Known Implementing Classes:

CompositeGauge, DropwizardGauge, NoopGauge, PrometheusGauge, SimpleGauge, SpectatorGauge

public interface Gauge
extends Meter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Gauge.Builder

Nested classes/interfaces inherited from interface io.micrometer.core.instrument.Meter

Meter.Type

Method Summary

Modifier and Type	Method and Description
default Meter.Type	getType()
default java.lang.Iterable<Measurement>	measure() Get a set of measurements.
double	value() Returns the current value.

Methods inherited from interface io.micrometer.core.instrument.Meter

getDescription, getName, getTags

Method Detail

value

double value()

Returns the current value. The act of observing the value by calling this method triggers sampling of the underlying number or user-defined function that defines the value for the gauge.

measure

default java.lang.Iterable<Measurement> measure()

Description copied from interface: Meter

Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.

Specified by:

measure in interface Meter

getType

default Meter.Type getType()

Specified by:

getType in interface Meter