Package io.micrometer.prometheusmetrics

Interface PrometheusConfig

All Superinterfaces:

io.micrometer.core.instrument.config.MeterRegistryConfig

public interface PrometheusConfig
extends io.micrometer.core.instrument.config.MeterRegistryConfig

Configuration for PrometheusMeterRegistry.

Since:

1.13.0

Field Summary

Fields

Modifier and Type	Field	Description
static final PrometheusConfig	DEFAULT	Accept configuration defaults

Method Summary

Modifier and Type	Method	Description
default boolean	descriptions()
default String	prefix()
default Properties	prometheusProperties()
default Duration	step()
default io.micrometer.core.instrument.config.validate.Validated<?>	validate()

Methods inherited from interface io.micrometer.core.instrument.config.MeterRegistryConfig

get, requireValid

Field Details

DEFAULT

static final PrometheusConfig DEFAULT

Accept configuration defaults

Method Details

prefix

default String prefix()

Specified by:

prefix in interface io.micrometer.core.instrument.config.MeterRegistryConfig

descriptions

default boolean descriptions()

Returns:

true if meter descriptions should be sent to Prometheus. Turn this off to minimize the amount of data sent on each scrape.

step

default Duration step()

Returns:

The step size to use in computing windowed statistics like max. The default is 1 minute. To get the most out of these statistics, align the step interval to be close to your scrape interval.

prometheusProperties

@Nullable
default Properties prometheusProperties()

Returns:

an instance of Properties that contains Prometheus Java Client config entries, for example io.prometheus.exporter.exemplarsOnAllMetricTypes=true.

Since:

1.13.0

See Also:

• Prometheus docs

validate

default io.micrometer.core.instrument.config.validate.Validated<?> validate()

Specified by:

validate in interface io.micrometer.core.instrument.config.MeterRegistryConfig