org.springframework.metrics.instrument

Interface MeterRegistry

All Known Implementing Classes:

AbstractMeterRegistry, PrometheusMeterRegistry, SimpleMeterRegistry, SpectatorMeterRegistry

public interface MeterRegistry

Creates and manages your application's set of meters. Exporters use the meter registry to iterate over the set of meters instrumenting your application, and then further iterate over each meter's metrics, generally resulting in a time series in the metrics backend for each combination of metrics and dimensions.

Method Summary

Modifier and Type	Method and Description
default <T extends java.util.Collection<?>> T	collectionSize(T collection, java.lang.String name, java.lang.Iterable<Tag> tags) Register a gauge that reports the size of the Collection.
default <T extends java.util.Collection<?>> T	collectionSize(T collection, java.lang.String name, Tag... tags) Register a gauge that reports the size of the Collection.
Counter	counter(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the rate of some activity.
default Counter	counter(java.lang.String name, java.lang.String... tags) Measures the rate of some activity.
<M extends Meter> java.util.Optional<M>	findMeter(java.lang.Class<M> mClass, java.lang.String name, java.lang.Iterable<Tag> tags)
default <M extends Meter> java.util.Optional<M>	findMeter(java.lang.Class<M> mClass, java.lang.String name, java.lang.String... tags)
java.util.Optional<Meter>	findMeter(Meter.Type type, java.lang.String name, java.lang.Iterable<Tag> tags)
default java.util.Optional<Meter>	findMeter(Meter.Type type, java.lang.String name, java.lang.String... tags)
default <T extends java.lang.Number> T	gauge(java.lang.String name, java.lang.Iterable<Tag> tags, T number) Register a gauge that reports the value of the Number.
<T> T	gauge(java.lang.String name, java.lang.Iterable<Tag> tags, T obj, java.util.function.ToDoubleFunction<T> f) Register a gauge that reports the value of the object after the function f is applied.
default <T extends java.lang.Number> T	gauge(java.lang.String name, T number) Register a gauge that reports the value of the Number.
default <T> T	gauge(java.lang.String name, T obj, java.util.function.ToDoubleFunction<T> f) Register a gauge that reports the value of the object.
Clock	getClock()
java.util.Collection<Meter>	getMeters()
LongTaskTimer	longTaskTimer(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the time taken for short tasks.
default LongTaskTimer	longTaskTimer(java.lang.String name, java.lang.String... tags) Measures the time taken for short tasks.
default <T extends java.util.Map<?,?>> T	mapSize(T map, java.lang.String name, java.lang.Iterable<Tag> tags) Register a gauge that reports the size of the Map.
default <T extends java.util.Map<?,?>> T	mapSize(T map, java.lang.String name, java.lang.String... tags) Register a gauge that reports the size of the Map.
MeterRegistry	register(Meter meter)
default DistributionSummary	summary(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the sample distribution of events.
default DistributionSummary	summary(java.lang.String name, java.lang.String... tags) Measures the sample distribution of events.
DistributionSummary.Builder	summaryBuilder(java.lang.String name) Build a new Distribution Summary, which is registered with this registry once DistributionSummary.Builder.create() is called.
default Timer	timer(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the time taken for short tasks.
default Timer	timer(java.lang.String name, java.lang.String... tags) Measures the time taken for short tasks.
Timer.Builder	timerBuilder(java.lang.String name) Build a new Timer, which is registered with this registry once Timer.Builder.create() is called.

Method Detail

getMeters

java.util.Collection<Meter> getMeters()

Returns:

The set of registered meters.

findMeter

default <M extends Meter> java.util.Optional<M> findMeter(java.lang.Class<M> mClass,
                                                          java.lang.String name,
                                                          java.lang.String... tags)

findMeter

<M extends Meter> java.util.Optional<M> findMeter(java.lang.Class<M> mClass,
                                                  java.lang.String name,
                                                  java.lang.Iterable<Tag> tags)

findMeter

default java.util.Optional<Meter> findMeter(Meter.Type type,
                                            java.lang.String name,
                                            java.lang.String... tags)

findMeter

java.util.Optional<Meter> findMeter(Meter.Type type,
                                    java.lang.String name,
                                    java.lang.Iterable<Tag> tags)

getClock

Clock getClock()

counter

Counter counter(java.lang.String name,
                java.lang.Iterable<Tag> tags)

Measures the rate of some activity.

counter

default Counter counter(java.lang.String name,
                        java.lang.String... tags)

Measures the rate of some activity.

summaryBuilder

DistributionSummary.Builder summaryBuilder(java.lang.String name)

Build a new Distribution Summary, which is registered with this registry once DistributionSummary.Builder.create() is called.

Parameters:

name - The name of the distribution summary (which is the only requirement for a new distribution summary).

Returns:

The builder.

summary

default DistributionSummary summary(java.lang.String name,
                                    java.lang.Iterable<Tag> tags)

Measures the sample distribution of events.

summary

default DistributionSummary summary(java.lang.String name,
                                    java.lang.String... tags)

Measures the sample distribution of events.

timerBuilder

Timer.Builder timerBuilder(java.lang.String name)

Build a new Timer, which is registered with this registry once Timer.Builder.create() is called.

Parameters:

name - The name of the timer (which is the only requirement for a new timer).

Returns:

The builder.

timer

default Timer timer(java.lang.String name,
                    java.lang.Iterable<Tag> tags)

Measures the time taken for short tasks.

timer

default Timer timer(java.lang.String name,
                    java.lang.String... tags)

Measures the time taken for short tasks.

longTaskTimer

LongTaskTimer longTaskTimer(java.lang.String name,
                            java.lang.Iterable<Tag> tags)

Measures the time taken for short tasks.

longTaskTimer

default LongTaskTimer longTaskTimer(java.lang.String name,
                                    java.lang.String... tags)

Measures the time taken for short tasks.

register

MeterRegistry register(Meter meter)

gauge

<T> T gauge(java.lang.String name,
            java.lang.Iterable<Tag> tags,
            T obj,
            java.util.function.ToDoubleFunction<T> f)

Register a gauge that reports the value of the object after the function f is applied. The registration will keep a weak reference to the object so it will not prevent garbage collection. Applying f on the object should be thread safe.

If multiple gauges are registered with the same id, then the values will be aggregated and the sum will be reported. For example, registering multiple gauges for active threads in a thread pool with the same id would produce a value that is the overall number of active threads. For other behaviors, manage it on the user side and avoid multiple registrations.

Parameters:

name - Name of the gauge being registered.

tags - Sequence of dimensions for breaking down the getName.

obj - Object used to compute a value.

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

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

gauge

default <T extends java.lang.Number> T gauge(java.lang.String name,
                                             java.lang.Iterable<Tag> tags,
                                             T number)

Register a gauge that reports the value of the Number.

Parameters:

name - Name of the gauge being registered.

tags - Sequence of dimensions for breaking down the getName.

number - Thread-safe implementation of Number used to access the value.

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

gauge

default <T extends java.lang.Number> T gauge(java.lang.String name,
                                             T number)

Register a gauge that reports the value of the Number.

Parameters:

name - Name of the gauge being registered.

number - Thread-safe implementation of Number used to access the value.

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

gauge

default <T> T gauge(java.lang.String name,
                    T obj,
                    java.util.function.ToDoubleFunction<T> f)

Register a gauge that reports the value of the object.

Parameters:

name - Name of the gauge being registered.

obj - Object used to compute a value.

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

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

collectionSize

default <T extends java.util.Collection<?>> T collectionSize(T collection,
                                                             java.lang.String name,
                                                             java.lang.Iterable<Tag> tags)

Register a gauge that reports the size of the Collection. The registration will keep a weak reference to the collection so it will not prevent garbage collection. The collection implementation used should be thread safe. Note that calling Collection.size() can be expensive for some collection implementations and should be considered before registering.

Parameters:

collection - Thread-safe implementation of Collection used to access the value.

name - Name of the gauge being registered.

tags - Sequence of dimensions for breaking down the getName.

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

collectionSize

default <T extends java.util.Collection<?>> T collectionSize(T collection,
                                                             java.lang.String name,
                                                             Tag... tags)

Register a gauge that reports the size of the Collection. The registration will keep a weak reference to the collection so it will not prevent garbage collection. The collection implementation used should be thread safe. Note that calling Collection.size() can be expensive for some collection implementations and should be considered before registering.

Parameters:

name - Name of the gauge being registered.

collection - Thread-safe implementation of Collection used to access the value.

tags - Tags to apply to the gauge.

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

mapSize

default <T extends java.util.Map<?,?>> T mapSize(T map,
                                                 java.lang.String name,
                                                 java.lang.Iterable<Tag> tags)

Register a gauge that reports the size of the Map. The registration will keep a weak reference to the collection so it will not prevent garbage collection. The collection implementation used should be thread safe. Note that calling Map.size() can be expensive for some collection implementations and should be considered before registering.

Parameters:

name - Name of the gauge being registered.

tags - Sequence of dimensions for breaking down the getName.

map - Thread-safe implementation of Map used to access the value.

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.

mapSize

default <T extends java.util.Map<?,?>> T mapSize(T map,
                                                 java.lang.String name,
                                                 java.lang.String... tags)

Register a gauge that reports the size of the Map. The registration will keep a weak reference to the collection so it will not prevent garbage collection. The collection implementation used should be thread safe. Note that calling Map.size() can be expensive for some collection implementations and should be considered before registering.

Parameters:

map - Thread-safe implementation of Map used to access the value.

name - Name of the gauge being registered.

tags - Tags to apply to the gauge.

Returns:

The number that was passed in so the registration can be done as part of an assignment statement.