Module io.helidon.webserver.observe.metrics

Package io.helidon.webserver.observe.metrics

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

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webserver.observe.metrics.MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

MetricsObserverConfig.Builder

Enclosing interface:

MetricsObserverConfig

public abstract static class MetricsObserverConfig.BuilderBase<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>
extends ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for MetricsObserverConfig.

Nested Class Summary

Nested Classes

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 io.helidon.webserver.observe.ObserverConfigBase.BuilderBase

ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
Optional<AutoHttpMetricsConfig>	autoHttpMetrics()	Automatic metrics collection settings.
BUILDER	autoHttpMetrics(AutoHttpMetricsConfig autoHttpMetrics)	Automatic metrics collection settings.
BUILDER	autoHttpMetrics(Consumer<AutoHttpMetricsConfig.Builder> consumer)	Automatic metrics collection settings.
BUILDER	autoHttpMetrics(Supplier<? extends AutoHttpMetricsConfig> supplier)	Automatic metrics collection settings.
BUILDER	clearAutoHttpMetrics()	Clear existing value of autoHttpMetrics.
BUILDER	clearMeterRegistry()	Clear existing value of meterRegistry.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
String	endpoint()	Endpoint option.
BUILDER	endpoint(String endpoint)	Endpoint option.
BUILDER	from(MetricsObserverConfig prototype)	Update this builder from an existing prototype instance.
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 = MetricsFactory.getInstance() .createMeterRegistry(metricsConfig); MetricsFeature.builder() .meterRegistry(meterRegistry) // further settings on the feature builder, etc. where metricsConfig in each case has different settings.
BUILDER	meterRegistry(MeterRegistry meterRegistry)	If you want to have multiple meter registries with different endpoints, you may create them using MeterRegistry meterRegistry = MetricsFactory.getInstance() .createMeterRegistry(metricsConfig); MetricsFeature.builder() .meterRegistry(meterRegistry) // further settings on the feature builder, etc. where metricsConfig in each case has different settings.
MetricsConfig	metricsConfig()	Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.
BUILDER	metricsConfig(MetricsConfig metricsConfig)	Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.
BUILDER	metricsConfig(Consumer<MetricsConfig.Builder> consumer)	Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.
BUILDER	metricsConfig(Supplier<? extends MetricsConfig> supplier)	Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webserver.observe.ObserverConfigBase.BuilderBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(MetricsObserverConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(MetricsObserverConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>

Overrides:

config in class ObserverConfigBase.BuilderBase<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>

Overrides:

config in class ObserverConfigBase.BuilderBase<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

endpoint

public BUILDER endpoint(String endpoint)

Endpoint option.

Parameters:

endpoint - the endpoint option

Returns:

updated builder instance

See Also:

• endpoint()

clearAutoHttpMetrics

public BUILDER clearAutoHttpMetrics()

Clear existing value of autoHttpMetrics.

Returns:

updated builder instance

See Also:

• autoHttpMetrics()

autoHttpMetrics

public BUILDER autoHttpMetrics(AutoHttpMetricsConfig autoHttpMetrics)

Automatic metrics collection settings.

Parameters:

autoHttpMetrics - auto metrics collection settings

Returns:

updated builder instance

See Also:

• autoHttpMetrics()

autoHttpMetrics

public BUILDER autoHttpMetrics(Consumer<AutoHttpMetricsConfig.Builder> consumer)

Automatic metrics collection settings.

Parameters:

consumer - consumer of builder of auto metrics collection settings

Returns:

updated builder instance

See Also:

• autoHttpMetrics()

autoHttpMetrics

public BUILDER autoHttpMetrics(Supplier<? extends AutoHttpMetricsConfig> supplier)

Automatic metrics collection settings.

Parameters:

supplier - supplier of auto metrics collection settings

Returns:

updated builder instance

See Also:

• autoHttpMetrics()

metricsConfig

public BUILDER metricsConfig(MetricsConfig metricsConfig)

Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.

Parameters:

metricsConfig - the metrics settings to assign for use in building the MetricsSupport instance

Returns:

updated builder instance

See Also:

• metricsConfig()

metricsConfig

public BUILDER metricsConfig(Consumer<MetricsConfig.Builder> consumer)

Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.

Parameters:

consumer - consumer of builder of the metrics settings to assign for use in building the MetricsSupport instance

Returns:

updated builder instance

See Also:

• metricsConfig()

metricsConfig

public BUILDER metricsConfig(Supplier<? extends MetricsConfig> supplier)

Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.

Parameters:

supplier - supplier of the metrics settings to assign for use in building the MetricsSupport instance

Returns:

updated builder instance

See Also:

• metricsConfig()

clearMeterRegistry

public BUILDER clearMeterRegistry()

Clear existing value of meterRegistry.

Returns:

updated builder instance

See Also:

• meterRegistry()

meterRegistry

public BUILDER meterRegistry(MeterRegistry meterRegistry)

If you want to have multiple meter registries with different endpoints, you may create them using

     MeterRegistry meterRegistry = MetricsFactory.getInstance()
             .createMeterRegistry(metricsConfig);
     MetricsFeature.builder()
             .meterRegistry(meterRegistry) // further settings on the feature builder, etc.

where metricsConfig in each case has different settings.

If this method is not called, MetricsFeature would use the shared instance as provided by MetricsFactory.globalRegistry().

Parameters:

meterRegistry - meterRegistry to use in this metric support

Returns:

updated builder instance

See Also:

• meterRegistry()

endpoint

public String endpoint()

Endpoint option.

Returns:

the endpoint option

autoHttpMetrics

public Optional<AutoHttpMetricsConfig> autoHttpMetrics()

Automatic metrics collection settings.

Returns:

auto metrics collection settings

metricsConfig

public MetricsConfig metricsConfig()

Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.

Returns:

the metrics settings to assign for use in building the MetricsSupport instance

meterRegistry

public Optional<MeterRegistry> meterRegistry()

If you want to have multiple meter registries with different endpoints, you may create them using

     MeterRegistry meterRegistry = MetricsFactory.getInstance()
             .createMeterRegistry(metricsConfig);
     MetricsFeature.builder()
             .meterRegistry(meterRegistry) // further settings on the feature builder, etc.

where metricsConfig in each case has different settings.

If this method is not called, MetricsFeature would use the shared instance as provided by MetricsFactory.globalRegistry().

Returns:

meterRegistry to use in this metric support

toString

public String toString()

Overrides:

toString in class ObserverConfigBase.BuilderBase<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ObserverConfigBase.BuilderBase<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ObserverConfigBase.BuilderBase<BUILDER extends MetricsObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsObserverConfig>