Interface PrometheusPublisherConfig

All Superinterfaces:

MetricsPublisherConfig, Prototype.Api, Prototype.Factory<PrometheusPublisher>

All Known Implementing Classes:

PrometheusPublisherConfig.BuilderBase.PrometheusPublisherConfigImpl

public interface PrometheusPublisherConfig
extends Prototype.Api

Settings for a Micrometer Prometheus meter registry.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PrometheusPublisherConfig.Builder	Fluent API builder for PrometheusPublisher.
static class	PrometheusPublisherConfig.BuilderBase<BUILDER extends PrometheusPublisherConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PrometheusPublisherConfig>	Fluent API builder base for PrometheusPublisherConfig.

Method Summary

Modifier and Type	Method	Description
static PrometheusPublisherConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static PrometheusPublisherConfig.Builder	builder(PrometheusPublisherConfig instance)	Create a new fluent API builder from an existing instance.
static PrometheusPublisherConfig	create()	Create a new instance with default values.
static PrometheusPublisherConfig	create(Config config)	Create a new instance from configuration.
Optional<Boolean>	descriptions()	Whether to include meter descriptions in Prometheus output.
boolean	enabled()	Whether the configured publisher is enabled.
Optional<Duration>	interval()	Step size used in computing "windowed" statistics.
Optional<PrometheusNamingConventionConfig>	namingConvention()	Prometheus naming convention settings.
Optional<String>	prefix()	Prefix for Micrometer Prometheus property lookups; this setting does not add a prefix to exported metric names, and the legacy prometheus.histogramFlavor property is accepted for compatibility but ignored with a warning.

Methods inherited from interface MetricsPublisherConfig

name

Modifier and Type	Method	Description
Optional<String>	name()	Name for this instance of the publisher.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
PrometheusPublisher	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static PrometheusPublisherConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static PrometheusPublisherConfig.Builder builder(PrometheusPublisherConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static PrometheusPublisherConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static PrometheusPublisherConfig create()

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

Whether the configured publisher is enabled.

Returns:

true if enabled, false otherwise

prefix

Optional<String> prefix()

Prefix for Micrometer Prometheus property lookups; this setting does not add a prefix to exported metric names, and the legacy prometheus.histogramFlavor property is accepted for compatibility but ignored with a warning.

Returns:

property lookup prefix

descriptions

Optional<Boolean> descriptions()

Whether to include meter descriptions in Prometheus output.

Returns:

true to include descriptions, false otherwise

interval

Optional<Duration> interval()

Step size used in computing "windowed" statistics. Micrometer advises that this value should be close to the interval with which backend systems scrape the Prometheus-format metrics data.

Returns:

step time

namingConvention

Optional<PrometheusNamingConventionConfig> namingConvention()

Prometheus naming convention settings.

Returns:

naming convention settings