io.micrometer.prometheus

Class PrometheusMeterRegistry

java.lang.Object

io.micrometer.core.instrument.AbstractMeterRegistry

io.micrometer.prometheus.PrometheusMeterRegistry

All Implemented Interfaces:

io.micrometer.core.instrument.MeterRegistry

public class PrometheusMeterRegistry
extends io.micrometer.core.instrument.AbstractMeterRegistry

Nested Class Summary

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

io.micrometer.core.instrument.MeterRegistry.Config, io.micrometer.core.instrument.MeterRegistry.More, io.micrometer.core.instrument.MeterRegistry.Search

Field Summary

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

clock

Constructor Summary

Constructors

Constructor and Description
PrometheusMeterRegistry(PrometheusConfig config)
PrometheusMeterRegistry(PrometheusConfig config, io.prometheus.client.CollectorRegistry registry, io.micrometer.core.instrument.Clock clock)

Method Summary

Modifier and Type	Method and Description
io.prometheus.client.CollectorRegistry	getPrometheusRegistry()
io.micrometer.core.instrument.Counter	newCounter(io.micrometer.core.instrument.Meter.Id id)
io.micrometer.core.instrument.DistributionSummary	newDistributionSummary(io.micrometer.core.instrument.Meter.Id id, io.micrometer.core.instrument.stats.hist.Histogram.Builder<?> histogram, io.micrometer.core.instrument.stats.quantile.Quantiles quantiles)
protected <T> io.micrometer.core.instrument.Gauge	newGauge(io.micrometer.core.instrument.Meter.Id id, T obj, java.util.function.ToDoubleFunction<T> f)
protected io.micrometer.core.instrument.LongTaskTimer	newLongTaskTimer(io.micrometer.core.instrument.Meter.Id id)
protected void	newMeter(io.micrometer.core.instrument.Meter.Id id, io.micrometer.core.instrument.Meter.Type type, java.lang.Iterable<io.micrometer.core.instrument.Measurement> measurements)
protected <T> io.micrometer.core.instrument.Gauge	newTimeGauge(io.micrometer.core.instrument.Meter.Id id, T obj, java.util.concurrent.TimeUnit fUnit, java.util.function.ToDoubleFunction<T> f)
protected io.micrometer.core.instrument.Timer	newTimer(io.micrometer.core.instrument.Meter.Id id, io.micrometer.core.instrument.stats.hist.Histogram.Builder<?> histogram, io.micrometer.core.instrument.stats.quantile.Quantiles quantiles)
java.lang.String	scrape() Content that should be included in the response body for an endpoint designate for Prometheus to scrape from.

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

config, counter, createId, find, gauge, getMeters, more, register, summary, timer

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

Constructor Detail

PrometheusMeterRegistry

public PrometheusMeterRegistry(PrometheusConfig config)

PrometheusMeterRegistry

public PrometheusMeterRegistry(PrometheusConfig config,
                               io.prometheus.client.CollectorRegistry registry,
                               io.micrometer.core.instrument.Clock clock)

Method Detail

scrape

public java.lang.String scrape()

Content that should be included in the response body for an endpoint designate for Prometheus to scrape from.

newCounter

public io.micrometer.core.instrument.Counter newCounter(io.micrometer.core.instrument.Meter.Id id)

Specified by:

newCounter in class io.micrometer.core.instrument.AbstractMeterRegistry

newDistributionSummary

public io.micrometer.core.instrument.DistributionSummary newDistributionSummary(io.micrometer.core.instrument.Meter.Id id,
                                                                                io.micrometer.core.instrument.stats.hist.Histogram.Builder<?> histogram,
                                                                                io.micrometer.core.instrument.stats.quantile.Quantiles quantiles)

Specified by:

newDistributionSummary in class io.micrometer.core.instrument.AbstractMeterRegistry

newTimer

protected io.micrometer.core.instrument.Timer newTimer(io.micrometer.core.instrument.Meter.Id id,
                                                       io.micrometer.core.instrument.stats.hist.Histogram.Builder<?> histogram,
                                                       io.micrometer.core.instrument.stats.quantile.Quantiles quantiles)

Specified by:

newTimer in class io.micrometer.core.instrument.AbstractMeterRegistry

newGauge

protected <T> io.micrometer.core.instrument.Gauge newGauge(io.micrometer.core.instrument.Meter.Id id,
                                                           T obj,
                                                           java.util.function.ToDoubleFunction<T> f)

Specified by:

newGauge in class io.micrometer.core.instrument.AbstractMeterRegistry

newLongTaskTimer

protected io.micrometer.core.instrument.LongTaskTimer newLongTaskTimer(io.micrometer.core.instrument.Meter.Id id)

Specified by:

newLongTaskTimer in class io.micrometer.core.instrument.AbstractMeterRegistry

newMeter

protected void newMeter(io.micrometer.core.instrument.Meter.Id id,
                        io.micrometer.core.instrument.Meter.Type type,
                        java.lang.Iterable<io.micrometer.core.instrument.Measurement> measurements)

Specified by:

newMeter in class io.micrometer.core.instrument.AbstractMeterRegistry

getPrometheusRegistry

public io.prometheus.client.CollectorRegistry getPrometheusRegistry()

Returns:

The underlying Prometheus CollectorRegistry.

newTimeGauge

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

Specified by:

newTimeGauge in class io.micrometer.core.instrument.AbstractMeterRegistry