Class MetricsObserverConfig.BuilderBase.MetricsObserverConfigImpl

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

io.helidon.webserver.observe.metrics.MetricsObserverConfig.BuilderBase.MetricsObserverConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<MetricsObserver>, MetricsObserverConfig, ObserverConfigBase, Supplier<MetricsObserver>

Enclosing class:

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

protected static class MetricsObserverConfig.BuilderBase.MetricsObserverConfigImpl
extends ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl
implements MetricsObserverConfig, Supplier<MetricsObserver>

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

Nested Class Summary

Nested classes/interfaces inherited from interface MetricsObserverConfig

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

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

Nested classes/interfaces inherited from interface ObserverConfigBase

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<AutoHttpMetricsConfig>	autoHttpMetrics()	Automatic metrics collection settings.
MetricsObserver	build()	Create a new runtime instance from this prototype.
String	endpoint()	Endpoint option.
boolean	equals(Object o)
MetricsObserver	get()
int	hashCode()
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.
MetricsConfig	metricsConfig()	Assigns metrics settings for the observer endpoint, including whether the endpoint is enabled and its access controls.
String	name()	Name of this observer.
String	toString()

Methods inherited from class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

config, enabled, name

Modifier and Type	Method	Description
Optional<Config>	config()	The config instance used to configure this observer.
boolean	enabled()	Whether this observer is enabled.
String	name()	Name of this observer.

Methods inherited from class Object

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

Constructor Details

MetricsObserverConfigImpl

protected MetricsObserverConfigImpl(MetricsObserverConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public MetricsObserver build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<MetricsObserver>

Returns:

new configured runtime instance

get

public MetricsObserver get()

Specified by:

get in interface Supplier<MetricsObserver>

endpoint

public String endpoint()

Description copied from interface: MetricsObserverConfig

Endpoint option.

Specified by:

endpoint in interface MetricsObserverConfig

Returns:

the endpoint option

autoHttpMetrics

public Optional<AutoHttpMetricsConfig> autoHttpMetrics()

Description copied from interface: MetricsObserverConfig

Automatic metrics collection settings.

Specified by:

autoHttpMetrics in interface MetricsObserverConfig

Returns:

auto metrics collection settings

metricsConfig

public MetricsConfig metricsConfig()

Description copied from interface: MetricsObserverConfig

Assigns metrics settings for the observer endpoint, including whether the endpoint is enabled and its access controls. With a custom MeterRegistry, the settings also describe the registry-specific behavior. With the shared registry, registry-specific behavior uses the settings from that registry's owning MetricsFactory while the endpoint settings assigned here still apply.

Specified by:

metricsConfig in interface MetricsObserverConfig

Returns:

metrics settings for the observer endpoint and, when configured, a custom registry

meterRegistry

public Optional<MeterRegistry> meterRegistry()

Description copied from interface: MetricsObserverConfig

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. Configure a different MetricsObserverConfig.endpoint() on each observer.

A meter registry has one effective set of registry-specific settings. Multiple metrics observers may share the same registry only when their registry-specific settings are equivalent; endpoint settings may differ. Use separate meter registries for observers that require different registry-specific behavior.

A custom meter registry passed to an observer remains caller-owned. Close it after all observers using it have stopped.

If this method is not called, a registry-managed MetricsObserver uses the shared instance from its owning ServiceRegistry. A directly created observer uses the global shared instance as provided by Services.get(MeterRegistry.class).

Specified by:

meterRegistry in interface MetricsObserverConfig

Returns:

meterRegistry to use in this metric support

toString

public String toString()

Overrides:

toString in class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

equals

public boolean equals(Object o)

Overrides:

equals in class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

name

String name()

Description copied from interface: ObserverConfigBase

Name of this observer. Each observer should provide its own default for this property.

Specified by:

name in interface ObserverConfigBase

Returns:

observer name