Class MetricsObserverConfig.Builder

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase<MetricsObserverConfig.Builder, MetricsObserverConfig>

io.helidon.webserver.observe.metrics.MetricsObserverConfig.BuilderBase<MetricsObserverConfig.Builder, MetricsObserverConfig>

io.helidon.webserver.observe.metrics.MetricsObserverConfig.Builder

All Implemented Interfaces:

Prototype.Builder<MetricsObserverConfig.Builder, MetricsObserverConfig>, Builder<MetricsObserverConfig.Builder, MetricsObserver>, ConfigBuilderSupport.ConfiguredBuilder<MetricsObserverConfig.Builder, MetricsObserverConfig>, Supplier<MetricsObserver>

Enclosing interface:

MetricsObserverConfig

public static class MetricsObserverConfig.Builder
extends MetricsObserverConfig.BuilderBase<MetricsObserverConfig.Builder, MetricsObserverConfig>
implements Builder<MetricsObserverConfig.Builder, MetricsObserver>

Fluent API builder for MetricsObserver.

Nested Class Summary

Nested classes/interfaces inherited from class MetricsObserverConfig.BuilderBase

MetricsObserverConfig.BuilderBase.MetricsObserverConfigImpl

Modifier and Type	Class	Description
protected static class	MetricsObserverConfig.BuilderBase.MetricsObserverConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class ObserverConfigBase.BuilderBase

ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

Modifier and Type	Class	Description
protected static class	ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
MetricsObserver	build()	Create an instance from this builder.
MetricsObserverConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class MetricsObserverConfig.BuilderBase

autoHttpMetrics, autoHttpMetrics, autoHttpMetrics, autoHttpMetrics, clearAutoHttpMetrics, clearMeterRegistry, config, endpoint, endpoint, from, from, meterRegistry, meterRegistry, metricsConfig, metricsConfig, metricsConfig, metricsConfig, preBuildPrototype, toString, validatePrototype

Modifier and Type	Method	Description
Optional<AutoHttpMetricsConfig>	autoHttpMetrics()	Automatic metrics collection settings.
MetricsObserverConfig.Builder	autoHttpMetrics(AutoHttpMetricsConfig autoHttpMetrics)	Automatic metrics collection settings.
MetricsObserverConfig.Builder	autoHttpMetrics(Consumer<AutoHttpMetricsConfig.Builder> consumer)	Automatic metrics collection settings.
MetricsObserverConfig.Builder	autoHttpMetrics(Supplier<? extends AutoHttpMetricsConfig> supplier)	Automatic metrics collection settings.
MetricsObserverConfig.Builder	clearAutoHttpMetrics()	Clear existing value of autoHttpMetrics.
MetricsObserverConfig.Builder	clearMeterRegistry()	Clear existing value of meterRegistry.
MetricsObserverConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
String	endpoint()	Endpoint option.
MetricsObserverConfig.Builder	endpoint(String endpoint)	Endpoint option.
MetricsObserverConfig.Builder	from(MetricsObserverConfig prototype)	Update this builder from an existing prototype instance.
MetricsObserverConfig.Builder	from(MetricsObserverConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<MeterRegistry>	meterRegistry()	If you want to have multiple meter registries with different endpoints, you may create them using MeterRegistry meterRegistry = io.helidon.service.registry.Services .get(io.helidon.metrics.api.MetricsFactory.class) .createMeterRegistry(metricsConfig); MetricsObserver.builder() .endpoint("metrics-2") .metricsConfig(metricsConfig) .meterRegistry(meterRegistry) // further settings on the observer builder, etc. .build(); where metricsConfig can contain registry-specific settings.
MetricsObserverConfig.Builder	meterRegistry(MeterRegistry meterRegistry)	If you want to have multiple meter registries with different endpoints, you may create them using MeterRegistry meterRegistry = io.helidon.service.registry.Services .get(io.helidon.metrics.api.MetricsFactory.class) .createMeterRegistry(metricsConfig); MetricsObserver.builder() .endpoint("metrics-2") .metricsConfig(metricsConfig) .meterRegistry(meterRegistry) // further settings on the observer builder, etc. .build(); where metricsConfig can contain registry-specific settings.
MetricsConfig	metricsConfig()	Assigns metrics settings for the observer endpoint, including whether the endpoint is enabled and its access controls.
MetricsObserverConfig.Builder	metricsConfig(MetricsConfig metricsConfig)	Assigns metrics settings for the observer endpoint, including whether the endpoint is enabled and its access controls.
MetricsObserverConfig.Builder	metricsConfig(Consumer<MetricsConfig.Builder> consumer)	Assigns metrics settings for the observer endpoint, including whether the endpoint is enabled and its access controls.
MetricsObserverConfig.Builder	metricsConfig(Supplier<? extends MetricsConfig> supplier)	Assigns metrics settings for the observer endpoint, including whether the endpoint is enabled and its access controls.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class ObserverConfigBase.BuilderBase

config, enabled, enabled, from, from, name, name

Modifier and Type	Method	Description
Optional<Config>	config()	The config instance used to configure this observer.
boolean	enabled()	Whether this observer is enabled.
MetricsObserverConfig.Builder	enabled(boolean enabled)	Whether this observer is enabled.
MetricsObserverConfig.Builder	from(ObserverConfigBase prototype)	Update this builder from an existing prototype instance.
MetricsObserverConfig.Builder	from(ObserverConfigBase.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	name()	Name of this observer.
MetricsObserverConfig.Builder	name(String name)	Name of this observer.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default MetricsObserver	get()
default MetricsObserverConfig.Builder	identity()	Instance of this builder as the correct type.
default MetricsObserverConfig.Builder	update(Consumer<MetricsObserverConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default MetricsObserverConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public MetricsObserverConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<MetricsObserverConfig.Builder, MetricsObserverConfig>

Returns:

an instance of the setup object created from this builder

build

public MetricsObserver build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<MetricsObserverConfig.Builder, MetricsObserver>

Returns:

instance of the built type