io.micrometer.core.instrument

Class AbstractMeterRegistry

java.lang.Object

io.micrometer.core.instrument.AbstractMeterRegistry

All Implemented Interfaces:

MeterRegistry

Direct Known Subclasses:

CompositeMeterRegistry, DropwizardMeterRegistry, SimpleMeterRegistry, SpectatorMeterRegistry

public abstract class AbstractMeterRegistry
extends java.lang.Object
implements MeterRegistry

Nested Class Summary

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

MeterRegistry.Config, MeterRegistry.More, MeterRegistry.Search

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock

Constructor Summary

Constructors

Constructor and Description
AbstractMeterRegistry(Clock clock)

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.
Meter.Id	createId(java.lang.String name, java.lang.Iterable<Tag> tag, 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.
java.util.Collection<Meter>	getMeters()
MeterRegistry.More	more() Access to less frequently used meter types and patterns.
protected abstract Counter	newCounter(Meter.Id id)
protected abstract DistributionSummary	newDistributionSummary(Meter.Id id, Histogram.Builder<?> histogram, Quantiles quantiles)
protected abstract <T> Gauge	newGauge(Meter.Id id, T obj, java.util.function.ToDoubleFunction<T> f)
protected abstract LongTaskTimer	newLongTaskTimer(Meter.Id id)
protected abstract void	newMeter(Meter.Id id, Meter.Type type, java.lang.Iterable<Measurement> measurements)
protected abstract <T> Gauge	newTimeGauge(Meter.Id id, T obj, java.util.concurrent.TimeUnit fUnit, java.util.function.ToDoubleFunction<T> f)
protected abstract Timer	newTimer(Meter.Id id, Histogram.Builder<?> histogram, Quantiles quantiles)
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.
Timer	timer(Meter.Id id, Histogram.Builder<?> histogram, Quantiles quantiles) Measures the time taken for short tasks and the count of these tasks.

Methods inherited from class java.lang.Object

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

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

counter, counter, createId, gauge, gauge, gauge, gauge, gaugeCollectionSize, gaugeMapSize, summary, summary, timer, timer

Field Detail

clock

protected final Clock clock

Constructor Detail

AbstractMeterRegistry

public AbstractMeterRegistry(Clock clock)

Method Detail

config

public MeterRegistry.Config config()

Description copied from interface: MeterRegistry

Access to configuration options for this registry.

Specified by:

config in interface MeterRegistry

newGauge

protected abstract <T> Gauge newGauge(Meter.Id id,
                                      T obj,
                                      java.util.function.ToDoubleFunction<T> f)

newCounter

protected abstract Counter newCounter(Meter.Id id)

newLongTaskTimer

protected abstract LongTaskTimer newLongTaskTimer(Meter.Id id)

newTimer

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

newDistributionSummary

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

newMeter

protected abstract void newMeter(Meter.Id id,
                                 Meter.Type type,
                                 java.lang.Iterable<Measurement> measurements)

newTimeGauge

protected abstract <T> Gauge newTimeGauge(Meter.Id id,
                                          T obj,
                                          java.util.concurrent.TimeUnit fUnit,
                                          java.util.function.ToDoubleFunction<T> f)

register

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

Description copied from interface: MeterRegistry

Register a custom meter type.

Specified by:

register in interface MeterRegistry

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.

counter

public Counter counter(Meter.Id id)

Description copied from interface: MeterRegistry

Tracks a monotonically increasing value.

Specified by:

counter in interface MeterRegistry

gauge

public <T> Gauge gauge(Meter.Id id,
                       T obj,
                       java.util.function.ToDoubleFunction<T> f)

Description copied from interface: MeterRegistry

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.

Specified by:

gauge in interface MeterRegistry

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.

timer

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

Description copied from interface: MeterRegistry

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

Specified by:

timer in interface MeterRegistry

summary

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

Description copied from interface: MeterRegistry

Measures the sample distribution of events.

Specified by:

summary in interface MeterRegistry

more

public MeterRegistry.More more()

Description copied from interface: MeterRegistry

Access to less frequently used meter types and patterns.

Specified by:

more in interface MeterRegistry

find

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

Specified by:

find in interface MeterRegistry

getMeters

public java.util.Collection<Meter> getMeters()

Specified by:

getMeters in interface MeterRegistry

Returns:

The set of registered meters.

createId

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

Specified by:

createId in interface MeterRegistry