Class PrometheusPublisherConfig.BuilderBase.PrometheusPublisherConfigImpl

java.lang.Object

io.helidon.metrics.providers.micrometer.PrometheusPublisherConfig.BuilderBase.PrometheusPublisherConfigImpl

All Implemented Interfaces:

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

Enclosing class:

PrometheusPublisherConfig.BuilderBase<BUILDER extends PrometheusPublisherConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PrometheusPublisherConfig>

protected static class PrometheusPublisherConfig.BuilderBase.PrometheusPublisherConfigImpl
extends Object
implements PrometheusPublisherConfig, Supplier<PrometheusPublisher>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface PrometheusPublisherConfig

PrometheusPublisherConfig.Builder, PrometheusPublisherConfig.BuilderBase<BUILDER, PROTOTYPE>

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusPublisherConfigImpl(PrometheusPublisherConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
PrometheusPublisher	build()	Create a new runtime instance from this prototype.
Optional<Boolean>	descriptions()	Whether to include meter descriptions in Prometheus output.
boolean	enabled()	Whether the configured publisher is enabled.
boolean	equals(Object o)
PrometheusPublisher	get()
int	hashCode()
Optional<Duration>	interval()	Step size used in computing "windowed" statistics.
Optional<String>	name()	Name for this instance of the publisher.
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.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PrometheusPublisherConfigImpl

protected PrometheusPublisherConfigImpl(PrometheusPublisherConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public PrometheusPublisher build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<PrometheusPublisher>

Returns:

new configured runtime instance

get

public PrometheusPublisher get()

Specified by:

get in interface Supplier<PrometheusPublisher>

enabled

public boolean enabled()

Description copied from interface: PrometheusPublisherConfig

Whether the configured publisher is enabled.

Specified by:

enabled in interface PrometheusPublisherConfig

Returns:

true if enabled, false otherwise

prefix

public Optional<String> prefix()

Description copied from interface: PrometheusPublisherConfig

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.

Specified by:

prefix in interface PrometheusPublisherConfig

Returns:

property lookup prefix

descriptions

public Optional<Boolean> descriptions()

Description copied from interface: PrometheusPublisherConfig

Whether to include meter descriptions in Prometheus output.

Specified by:

descriptions in interface PrometheusPublisherConfig

Returns:

true to include descriptions, false otherwise

interval

public Optional<Duration> interval()

Description copied from interface: PrometheusPublisherConfig

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.

Specified by:

interval in interface PrometheusPublisherConfig

Returns:

step time

namingConvention

public Optional<PrometheusNamingConventionConfig> namingConvention()

Description copied from interface: PrometheusPublisherConfig

Prometheus naming convention settings.

Specified by:

namingConvention in interface PrometheusPublisherConfig

Returns:

naming convention settings

name

public Optional<String> name()

Description copied from interface: MetricsPublisherConfig

Name for this instance of the publisher.

Specified by:

name in interface MetricsPublisherConfig

Returns:

name of the publisher instance

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object