io.micrometer.core.instrument.composite

Class CompositeMeterRegistry

java.lang.Object

io.micrometer.core.instrument.MeterRegistry

io.micrometer.core.instrument.composite.CompositeMeterRegistry

public class CompositeMeterRegistry
extends MeterRegistry

The clock of the composite effectively overrides the clocks of the registries it manages without actually replacing the state of the clock in these registries with the exception of long task timers, whose clock cannot be overridden.

Nested Class Summary

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

MeterRegistry.Config, MeterRegistry.More

Field Summary

Fields inherited from class io.micrometer.core.instrument.MeterRegistry

clock

Constructor Summary

Constructors

Constructor and Description
CompositeMeterRegistry()
CompositeMeterRegistry(Clock clock)
CompositeMeterRegistry(Clock clock, java.lang.Iterable<MeterRegistry> registries)

Method Summary

Modifier and Type	Method and Description
CompositeMeterRegistry	add(MeterRegistry registry)
void	close() Closes this registry, releasing any resources in the process.
protected DistributionStatisticConfig	defaultHistogramConfig() Every custom registry implementation should define a default histogram expiry at a minimum:
protected java.util.concurrent.TimeUnit	getBaseTimeUnit()
java.util.Set<MeterRegistry>	getRegistries()
protected Counter	newCounter(Meter.Id id) Build a new counter to be added to the registry.
protected DistributionSummary	newDistributionSummary(Meter.Id id, DistributionStatisticConfig distributionStatisticConfig, double scale) Build a new distribution summary to be added to the registry.
protected <T> FunctionCounter	newFunctionCounter(Meter.Id id, T obj, java.util.function.ToDoubleFunction<T> countFunction) Build a new function counter to be added to the registry.
protected <T> FunctionTimer	newFunctionTimer(Meter.Id id, T obj, java.util.function.ToLongFunction<T> countFunction, java.util.function.ToDoubleFunction<T> totalTimeFunction, java.util.concurrent.TimeUnit totalTimeFunctionUnit) Build a new function timer to be added to the registry.
protected <T> Gauge	newGauge(Meter.Id id, T obj, java.util.function.ToDoubleFunction<T> valueFunction) Build a new gauge to be added to the registry.
protected LongTaskTimer	newLongTaskTimer(Meter.Id id) Build a new long task timer to be added to the registry.
protected Meter	newMeter(Meter.Id id, Meter.Type type, java.lang.Iterable<Measurement> measurements) Build a new custom meter to be added to the registry.
protected <T> TimeGauge	newTimeGauge(Meter.Id id, T obj, java.util.concurrent.TimeUnit valueFunctionUnit, java.util.function.ToDoubleFunction<T> valueFunction) Build a new time gauge to be added to the registry.
protected Timer	newTimer(Meter.Id id, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector) Build a new timer to be added to the registry.
CompositeMeterRegistry	remove(MeterRegistry registry)

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

config, counter, counter, find, forEachMeter, gauge, gauge, gauge, gauge, gaugeCollectionSize, gaugeMapSize, get, getConventionName, getConventionTags, getMeters, isClosed, more, remove, remove, summary, summary, timer, timer

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeMeterRegistry

public CompositeMeterRegistry()

CompositeMeterRegistry

public CompositeMeterRegistry(Clock clock)

CompositeMeterRegistry

public CompositeMeterRegistry(Clock clock,
                              java.lang.Iterable<MeterRegistry> registries)

Method Detail

newTimer

protected Timer newTimer(Meter.Id id,
                         DistributionStatisticConfig distributionStatisticConfig,
                         PauseDetector pauseDetector)

Description copied from class: MeterRegistry

Build a new timer to be added to the registry. This is guaranteed to only be called if the timer doesn't already exist.

Specified by:

newTimer in class MeterRegistry

Parameters:

id - The id that uniquely identifies the timer.

distributionStatisticConfig - Configuration for published distribution statistics.

pauseDetector - The pause detector to use for coordinated omission compensation.

Returns:

A new timer.

newDistributionSummary

protected DistributionSummary newDistributionSummary(Meter.Id id,
                                                     DistributionStatisticConfig distributionStatisticConfig,
                                                     double scale)

Description copied from class: MeterRegistry

Build a new distribution summary to be added to the registry. This is guaranteed to only be called if the distribution summary doesn't already exist.

Specified by:

newDistributionSummary in class MeterRegistry

Parameters:

id - The id that uniquely identifies the distribution summary.

distributionStatisticConfig - Configuration for published distribution statistics.

scale - Multiply every recorded sample by this factor.

Returns:

A new distribution summary.

newCounter

protected Counter newCounter(Meter.Id id)

Description copied from class: MeterRegistry

Build a new counter to be added to the registry. This is guaranteed to only be called if the counter doesn't already exist.

Specified by:

newCounter in class MeterRegistry

Parameters:

id - The id that uniquely identifies the counter.

Returns:

A new counter.

newLongTaskTimer

protected LongTaskTimer newLongTaskTimer(Meter.Id id)

Description copied from class: MeterRegistry

Build a new long task timer to be added to the registry. This is guaranteed to only be called if the long task timer doesn't already exist.

Specified by:

newLongTaskTimer in class MeterRegistry

Parameters:

id - The id that uniquely identifies the long task timer.

Returns:

A new long task timer.

newGauge

protected <T> Gauge newGauge(Meter.Id id,
                             @Nullable
                             T obj,
                             java.util.function.ToDoubleFunction<T> valueFunction)

Description copied from class: MeterRegistry

Build a new gauge to be added to the registry. This is guaranteed to only be called if the gauge doesn't already exist.

Specified by:

newGauge in class MeterRegistry

Type Parameters:

T - The type of the state object from which the gauge value is extracted.

Parameters:

id - The id that uniquely identifies the gauge.

obj - State object used to compute a value.

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

Returns:

A new gauge.

newTimeGauge

protected <T> TimeGauge newTimeGauge(Meter.Id id,
                                     @Nullable
                                     T obj,
                                     java.util.concurrent.TimeUnit valueFunctionUnit,
                                     java.util.function.ToDoubleFunction<T> valueFunction)

Description copied from class: MeterRegistry

Build a new time gauge to be added to the registry. This is guaranteed to only be called if the time gauge doesn't already exist.

Overrides:

newTimeGauge in class MeterRegistry

Type Parameters:

T - The type of the object upon which the value function derives a measurement.

Parameters:

id - The id that uniquely identifies the time gauge.

obj - The state object from which the value function derives a measurement.

valueFunctionUnit - The base unit of time returned by the value function.

valueFunction - A function returning a time value that can go up or down.

Returns:

A new time gauge.

newFunctionTimer

protected <T> FunctionTimer newFunctionTimer(Meter.Id id,
                                             T obj,
                                             java.util.function.ToLongFunction<T> countFunction,
                                             java.util.function.ToDoubleFunction<T> totalTimeFunction,
                                             java.util.concurrent.TimeUnit totalTimeFunctionUnit)

Description copied from class: MeterRegistry

Build a new function timer to be added to the registry. This is guaranteed to only be called if the function timer doesn't already exist.

Specified by:

newFunctionTimer in class MeterRegistry

Type Parameters:

T - The type of the object upon which the value functions derives their measurements.

Parameters:

id - The id that uniquely identifies the function timer.

obj - The state object from which the count and total functions derive measurements.

countFunction - A monotonically increasing count function.

totalTimeFunction - A monotonically increasing total time function.

totalTimeFunctionUnit - The base unit of time of the totals returned by the total time function.

Returns:

A new function timer.

newFunctionCounter

protected <T> FunctionCounter newFunctionCounter(Meter.Id id,
                                                 T obj,
                                                 java.util.function.ToDoubleFunction<T> countFunction)

Description copied from class: MeterRegistry

Build a new function counter to be added to the registry. This is guaranteed to only be called if the function counter doesn't already exist.

Specified by:

newFunctionCounter in class MeterRegistry

Type Parameters:

T - The type of the object upon which the value function derives a measurement.

Parameters:

id - The id that uniquely identifies the function counter.

obj - The state object from which the count function derives a measurement.

countFunction - A monotonically increasing count function.

Returns:

A new function counter.

getBaseTimeUnit

protected java.util.concurrent.TimeUnit getBaseTimeUnit()

Specified by:

getBaseTimeUnit in class MeterRegistry

Returns:

the registry's base TimeUnit. Must not be null.

defaultHistogramConfig

protected DistributionStatisticConfig defaultHistogramConfig()

Description copied from class: MeterRegistry

Every custom registry implementation should define a default histogram expiry at a minimum:

 DistributionStatisticConfig.builder()
    .expiry(defaultStep)
    .build()
    .merge(DistributionStatisticConfig.DEFAULT);
 

Specified by:

defaultHistogramConfig in class MeterRegistry

Returns:

The default distribution statistics config.

newMeter

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

Description copied from class: MeterRegistry

Build a new custom meter to be added to the registry. This is guaranteed to only be called if the custom meter doesn't already exist.

Specified by:

newMeter in class MeterRegistry

Parameters:

id - The id that uniquely identifies the custom meter.

type - What kind of meter this is.

measurements - A set of measurements describing how to sample this meter.

Returns:

A new custom meter.

add

public CompositeMeterRegistry add(MeterRegistry registry)

remove

public CompositeMeterRegistry remove(MeterRegistry registry)

getRegistries

public java.util.Set<MeterRegistry> getRegistries()

close

public void close()

Description copied from class: MeterRegistry

Closes this registry, releasing any resources in the process. Once closed, this registry will no longer accept new meters and any publishing activity will cease.

Overrides:

close in class MeterRegistry