io.micrometer.core.instrument

Class Meters.Builder

java.lang.Object

io.micrometer.core.instrument.Meters.Builder

Enclosing class:

Meters

public static class Meters.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Meter	create(java.util.function.Function<java.lang.String,java.lang.Iterable<Measurement>> measure)
<T> Meter	create(T obj, java.util.function.BiFunction<java.lang.String,T,java.lang.Iterable<Measurement>> measure)
Meters.Builder	tags(java.lang.Iterable<Tag> tags)
Meters.Builder	tags(java.lang.String... tags)
Meters.Builder	type(Meter.Type type)

Methods inherited from class java.lang.Object

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

Method Detail

tags

public Meters.Builder tags(java.lang.Iterable<Tag> tags)

tags

public Meters.Builder tags(java.lang.String... tags)

type

public Meters.Builder type(Meter.Type type)

create

public Meter create(java.util.function.Function<java.lang.String,java.lang.Iterable<Measurement>> measure)

Parameters:

measure - A function of meter name to a set of measurements. The generated measurements will be enriched with the containing meter's tags automatically.

Returns:

A custom meter

create

public <T> Meter create(T obj,
                        java.util.function.BiFunction<java.lang.String,T,java.lang.Iterable<Measurement>> measure)

Parameters:

obj - The monitored object. Access to this object's state from the meter must be thread safe. For example, if the monitored object is a collection type, ensure it is from the java.util.concurrent package.

measure - A function of a meter name and a monitored object to a set of measurements. The generated measurements will be enriched with the containing meter's tags automatically. The monitored object is held with a weak reference, so as not to prevent garbage collection of the underlying object.

Returns:

A custom meter. Once the underlying object has been garbage collected, this meter will emit an empty set of measurements on sampling.