io.micrometer.core.instrument

Interface MeterRegistry

All Known Implementing Classes:

AbstractMeterRegistry, CompositeMeterRegistry, DropwizardMeterRegistry, SimpleMeterRegistry, SpectatorMeterRegistry, StepSpectatorMeterRegistry

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. MeterRegistry may be used in a reactive context. As such, implementations must not negatively impact the calling thread, e.g. it should respond immediately by avoiding IO call, deep stack recursion or any coordination.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MeterRegistry.Config
static interface	MeterRegistry.More
static interface	MeterRegistry.Search

Method Summary

Modifier and Type	Method and Description
MeterRegistry.Config	config() Access to configuration options for this registry.
Counter	counter(Meter.Id id) Tracks a monotonically increasing value.
default Counter	counter(java.lang.String name, java.lang.Iterable<Tag> tags) Tracks a monotonically increasing value.
default Counter	counter(java.lang.String name, java.lang.String... tags) Tracks a monotonically increasing value.
default Meter.Id	createId(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description)
Meter.Id	createId(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description, java.lang.String baseUnit)
MeterRegistry.Search	find(java.lang.String name)
<T> Gauge	gauge(Meter.Id id, 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, java.lang.Iterable<Tag> tags, T number) Register a gauge that reports the value of the Number.
default <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.
default <T extends java.util.Collection<?>> T	gaugeCollectionSize(java.lang.String name, java.lang.Iterable<Tag> tags, T collection) Register a gauge that reports the size of the Collection.
default <T extends java.util.Map<?,?>> T	gaugeMapSize(java.lang.String name, java.lang.Iterable<Tag> tags, T map) Register a gauge that reports the size of the Map.
java.util.Collection<Meter>	getMeters()
MeterRegistry.More	more() Access to less frequently used meter types and patterns.
Meter	register(Meter.Id id, Meter.Type type, java.lang.Iterable<Measurement> measurements) Register a custom meter type.
DistributionSummary	summary(Meter.Id id, Histogram.Builder<?> histogram, Quantiles quantiles) Measures the sample distribution of events.
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.
Timer	timer(Meter.Id id, Histogram.Builder<?> histogram, Quantiles quantiles) Measures the time taken for short tasks and the count of these tasks.
default Timer	timer(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the time taken for short tasks and the count of these tasks.
default Timer	timer(java.lang.String name, java.lang.String... tags) Measures the time taken for short tasks and the count of these tasks.

Method Detail

getMeters

java.util.Collection<Meter> getMeters()

Returns:

The set of registered meters.

config

MeterRegistry.Config config()

Access to configuration options for this registry.

find

MeterRegistry.Search find(java.lang.String name)

counter

Counter counter(Meter.Id id)

Tracks a monotonically increasing value.

counter

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

Tracks a monotonically increasing value.

counter

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

Tracks a monotonically increasing value.

Parameters:

name - The base metric name

tags - MUST be an even number of arguments representing key/value pairs of tags.

summary

DistributionSummary summary(Meter.Id id,
                            Histogram.Builder<?> histogram,
                            Quantiles quantiles)

Measures the sample distribution of events.

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.

Parameters:

name - The base metric name

tags - MUST be an even number of arguments representing key/value pairs of tags.

timer

Timer timer(Meter.Id id,
            Histogram.Builder<?> histogram,
            Quantiles quantiles)

Measures the time taken for short tasks and the count of these tasks.

timer

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

Measures the time taken for short tasks and the count of these tasks.

timer

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

Measures the time taken for short tasks and the count of these tasks.

Parameters:

name - The base metric name

tags - MUST be an even number of arguments representing key/value pairs of tags.

more

MeterRegistry.More more()

Access to less frequently used meter types and patterns.

register

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

Register a custom meter type.

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.

gauge

<T> Gauge gauge(Meter.Id id,
                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:

id - Id 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.

gauge

default <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 name.

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 name.

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.

gaugeCollectionSize

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

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.

tags - Sequence of dimensions for breaking down the name.

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

Returns:

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

gaugeMapSize

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

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 name.

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.

createId

default Meter.Id createId(java.lang.String name,
                          java.lang.Iterable<Tag> tags,
                          java.lang.String description)

createId

Meter.Id createId(java.lang.String name,
                  java.lang.Iterable<Tag> tags,
                  java.lang.String description,
                  java.lang.String baseUnit)