org.springframework.metrics.instrument.prometheus

Class PrometheusMeterRegistry

java.lang.Object

org.springframework.metrics.instrument.internal.AbstractMeterRegistry

org.springframework.metrics.instrument.prometheus.PrometheusMeterRegistry

All Implemented Interfaces:

MeterRegistry

public class PrometheusMeterRegistry
extends AbstractMeterRegistry

Field Summary

Fields inherited from class org.springframework.metrics.instrument.internal.AbstractMeterRegistry

clock

Constructor Summary

Constructors

Constructor and Description
PrometheusMeterRegistry()
PrometheusMeterRegistry(io.prometheus.client.CollectorRegistry registry)
PrometheusMeterRegistry(io.prometheus.client.CollectorRegistry registry, Clock clock)

Method Summary

Modifier and Type	Method and Description
Counter	counter(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the rate of some activity.
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()
io.prometheus.client.CollectorRegistry	getPrometheusRegistry()
LongTaskTimer	longTaskTimer(java.lang.String name, java.lang.Iterable<Tag> tags) Measures the time taken for short tasks.
MeterRegistry	register(Meter meter)
protected Timer	timer(java.lang.String name, java.lang.Iterable<Tag> tags, Quantiles quantiles, Histogram<?> histogram)

Methods inherited from class org.springframework.metrics.instrument.internal.AbstractMeterRegistry

getClock, summaryBuilder, timerBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.metrics.instrument.MeterRegistry

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

Constructor Detail

PrometheusMeterRegistry

public PrometheusMeterRegistry()

PrometheusMeterRegistry

public PrometheusMeterRegistry(io.prometheus.client.CollectorRegistry registry)

PrometheusMeterRegistry

@Autowired
public PrometheusMeterRegistry(io.prometheus.client.CollectorRegistry registry,
                                          Clock clock)

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

Measures the rate of some activity.

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.

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.

register

public MeterRegistry register(Meter meter)

getPrometheusRegistry

public io.prometheus.client.CollectorRegistry getPrometheusRegistry()

Returns:

The underlying Prometheus CollectorRegistry.