io.micrometer.core.instrument.spectator

Class SpectatorMeterRegistry

java.lang.Object

io.micrometer.core.instrument.AbstractMeterRegistry

io.micrometer.core.instrument.spectator.SpectatorMeterRegistry

All Implemented Interfaces:

MeterRegistry

Direct Known Subclasses:

AtlasMeterRegistry, DatadogMeterRegistry, InfluxMeterRegistry

public abstract class SpectatorMeterRegistry
extends AbstractMeterRegistry

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<com.netflix.spectator.api.Meter,Meter>	meterMap

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

clock, commonTags

Constructor Summary

Constructors

Constructor and Description
SpectatorMeterRegistry(com.netflix.spectator.api.Registry registry, Clock clock, TagFormatter tagFormatter)

Method Summary

Modifier and Type	Method and Description
Counter	counter(java.lang.String name, java.lang.Iterable<Tag> tags) Tracks a monotonically increasing value.
DistributionSummary	distributionSummary(java.lang.String name, java.lang.Iterable<Tag> tags, Quantiles quantiles, Histogram<?> histogram)
<M extends Meter> java.util.Optional<M>	findMeter(java.lang.Class<M> mClass, java.lang.String name, java.lang.Iterable<Tag> tags)
java.util.Optional<Meter>	findMeter(Meter.Type type, java.lang.String name, java.lang.Iterable<Tag> tags)
<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.
java.util.Collection<Meter>	getMeters()
com.netflix.spectator.api.Registry	getSpectatorRegistry()
LongTaskTimer	longTaskTimer(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the time taken for short tasks.
protected com.netflix.spectator.api.Counter	newCounter(java.lang.String name, java.lang.Iterable<Tag> tags) If using a custom spectator Registry type that does not extend from AbstractRegistry, provide a mechanism to create a new counter that doesn't register it with the registry.
MeterRegistry	register(Meter meter)
protected <T> T	stepCounter(java.lang.String name, java.lang.Iterable<Tag> tags, T obj, java.util.function.ToDoubleFunction<T> f, long stepMillis) Builds a step-interval based counter that is incremented on observation with the difference between the current value of a monotonically increasing function f and the last observation of f.
protected Timer	timer(java.lang.String name, java.lang.Iterable<Tag> tags, Quantiles quantiles, Histogram<?> histogram)

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

commonTags, getClock, summaryBuilder, timerBuilder, withCommonTags

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

collectionSize, collectionSize, commonTags, counter, counter, counter, counter, counter, findMeter, findMeter, gauge, gauge, gauge, longTaskTimer, mapSize, mapSize, summary, summary, timer, timer

Field Detail

meterMap

protected final java.util.Map<com.netflix.spectator.api.Meter,Meter> meterMap

Constructor Detail

SpectatorMeterRegistry

public SpectatorMeterRegistry(com.netflix.spectator.api.Registry registry,
                              Clock clock,
                              TagFormatter tagFormatter)

Method Detail

getMeters

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

Returns:

The set of registered meters.

findMeter

public <M extends Meter> java.util.Optional<M> findMeter(java.lang.Class<M> mClass,
                                                         java.lang.String name,
                                                         java.lang.Iterable<Tag> tags)

findMeter

public java.util.Optional<Meter> findMeter(Meter.Type type,
                                           java.lang.String name,
                                           java.lang.Iterable<Tag> tags)

counter

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

Description copied from interface: MeterRegistry

Tracks a monotonically increasing value.

newCounter

protected com.netflix.spectator.api.Counter newCounter(java.lang.String name,
                                                       java.lang.Iterable<Tag> tags)

If using a custom spectator Registry type that does not extend from AbstractRegistry, provide a mechanism to create a new counter that doesn't register it with the registry.

Returns:

A new counter that has not yet been registered with the registry.

distributionSummary

public DistributionSummary distributionSummary(java.lang.String name,
                                               java.lang.Iterable<Tag> tags,
                                               Quantiles quantiles,
                                               Histogram<?> histogram)

Specified by:

distributionSummary in class AbstractMeterRegistry

timer

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

Specified by:

timer in class AbstractMeterRegistry

longTaskTimer

public LongTaskTimer longTaskTimer(java.lang.String name,
                                   java.lang.Iterable<Tag> tags)

Description copied from interface: MeterRegistry

Measures the time taken for short tasks.

register

public MeterRegistry register(Meter meter)

gauge

public <T> T gauge(java.lang.String name,
                   java.lang.Iterable<Tag> tags,
                   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.

Parameters:

name - Name of the gauge being registered.

tags - Sequence of dimensions for breaking down the getName.

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.

getSpectatorRegistry

public com.netflix.spectator.api.Registry getSpectatorRegistry()

Returns:

The underlying Spectator Registry.

stepCounter

protected <T> T stepCounter(java.lang.String name,
                            java.lang.Iterable<Tag> tags,
                            T obj,
                            java.util.function.ToDoubleFunction<T> f,
                            long stepMillis)

Builds a step-interval based counter that is incremented on observation with the difference between the current value of a monotonically increasing function f and the last observation of f.