io.micrometer.core.instrument

Class AbstractMeterRegistry

java.lang.Object

io.micrometer.core.instrument.AbstractMeterRegistry

All Implemented Interfaces:

MeterRegistry

Direct Known Subclasses:

CompositeMeterRegistry, DropwizardMeterRegistry, PrometheusMeterRegistry, 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.Builder	counterBuilder(java.lang.String name) Build a new Counter, which is registered with this registry once Counter.Builder.create() is called.
MeterRegistry.Search	find(java.lang.String name)
<T> Gauge.Builder	gaugeBuilder(java.lang.String name, T obj, java.util.function.ToDoubleFunction<T> f) Build a new Gauge, which is registered with this registry once Gauge.Builder.create() is called.
java.util.Collection<Meter>	getMeters()
MeterRegistry.More	more() Access to less frequently used meter types and patterns.
protected abstract Counter	newCounter(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description)
protected abstract DistributionSummary	newDistributionSummary(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description, Quantiles quantiles, Histogram<?> histogram)
protected abstract <T> Gauge	newGauge(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description, java.util.function.ToDoubleFunction<T> f, T obj)
protected abstract LongTaskTimer	newLongTaskTimer(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description)
protected abstract void	newMeter(java.lang.String name, java.lang.Iterable<Tag> tags, Meter.Type type, java.lang.Iterable<Measurement> measurements)
protected abstract Timer	newTimer(java.lang.String name, java.lang.Iterable<Tag> tags, java.lang.String description, Histogram<?> histogram, Quantiles quantiles)
MeterRegistry	register(java.lang.String name, java.lang.Iterable<Tag> tags, Meter.Type type, java.lang.Iterable<Measurement> measurements)
DistributionSummary.Builder	summaryBuilder(java.lang.String name) Build a new Distribution Summary, which is registered with this registry once DistributionSummary.Builder.create() is called.
Timer.Builder	timerBuilder(java.lang.String name) Build a new Timer, which is registered with this registry once Timer.Builder.create() is called.

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, 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

newDistributionSummary

protected abstract DistributionSummary newDistributionSummary(java.lang.String name,
                                                              java.lang.Iterable<Tag> tags,
                                                              java.lang.String description,
                                                              Quantiles quantiles,
                                                              Histogram<?> histogram)

newGauge

protected abstract <T> Gauge newGauge(java.lang.String name,
                                      java.lang.Iterable<Tag> tags,
                                      java.lang.String description,
                                      java.util.function.ToDoubleFunction<T> f,
                                      T obj)

newCounter

protected abstract Counter newCounter(java.lang.String name,
                                      java.lang.Iterable<Tag> tags,
                                      java.lang.String description)

newLongTaskTimer

protected abstract LongTaskTimer newLongTaskTimer(java.lang.String name,
                                                  java.lang.Iterable<Tag> tags,
                                                  java.lang.String description)

newTimer

protected abstract Timer newTimer(java.lang.String name,
                                  java.lang.Iterable<Tag> tags,
                                  java.lang.String description,
                                  Histogram<?> histogram,
                                  Quantiles quantiles)

newMeter

protected abstract void newMeter(java.lang.String name,
                                 java.lang.Iterable<Tag> tags,
                                 Meter.Type type,
                                 java.lang.Iterable<Measurement> measurements)

register

public MeterRegistry register(java.lang.String name,
                              java.lang.Iterable<Tag> tags,
                              Meter.Type type,
                              java.lang.Iterable<Measurement> measurements)

Specified by:

register in interface MeterRegistry

gaugeBuilder

public final <T> Gauge.Builder gaugeBuilder(java.lang.String name,
                                            T obj,
                                            java.util.function.ToDoubleFunction<T> f)

Description copied from interface: MeterRegistry

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

Specified by:

gaugeBuilder in interface MeterRegistry

Parameters:

name - The name of the gauge.

obj - Object used to compute a value.

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

Returns:

The builder.

timerBuilder

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

Description copied from interface: MeterRegistry

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

Specified by:

timerBuilder in interface MeterRegistry

Parameters:

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

Returns:

The builder.

summaryBuilder

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

Description copied from interface: MeterRegistry

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

Specified by:

summaryBuilder in interface MeterRegistry

Parameters:

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

Returns:

The builder.

counterBuilder

public Counter.Builder counterBuilder(java.lang.String name)

Description copied from interface: MeterRegistry

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

Specified by:

counterBuilder in interface MeterRegistry

Parameters:

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

Returns:

The builder.

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.