Class MetricsConfig.Builder

java.lang.Object

io.helidon.metrics.api.MetricsConfig.BuilderBase<MetricsConfig.Builder, MetricsConfig>

io.helidon.metrics.api.MetricsConfig.Builder

All Implemented Interfaces:

Prototype.Builder<MetricsConfig.Builder, MetricsConfig>, Builder<MetricsConfig.Builder, MetricsConfig>, ConfigBuilderSupport.ConfiguredBuilder<MetricsConfig.Builder, MetricsConfig>, Supplier<MetricsConfig>

Enclosing interface:

MetricsConfig

public static class MetricsConfig.Builder
extends MetricsConfig.BuilderBase<MetricsConfig.Builder, MetricsConfig>
implements Builder<MetricsConfig.Builder, MetricsConfig>

Fluent API builder for MetricsConfig.

Nested Class Summary

Nested classes/interfaces inherited from class MetricsConfig.BuilderBase

MetricsConfig.BuilderBase.MetricsConfigImpl

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

Method Summary

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

Methods inherited from class MetricsConfig.BuilderBase

addPublisher, addPublishers, addRoles, addTags, appName, appName, appTagName, appTagName, builtInMeterNameFormat, builtInMeterNameFormat, clearAppName, clearAppTagName, clearJsonUnitsDefault, clearPublishers, clearRoles, clearTags, config, config, enabled, enabled, from, from, jsonUnitsDefault, jsonUnitsDefault, keyPerformanceIndicatorMetricsConfig, keyPerformanceIndicatorMetricsConfig, keyPerformanceIndicatorMetricsConfig, keyPerformanceIndicatorMetricsConfig, permitAll, permitAll, preBuildPrototype, publishers, publishers, publishersDiscoverServices, publishersDiscoverServices, restRequestEnabled, restRequestEnabled, roles, roles, scoping, scoping, scoping, scoping, tags, tags, toString, validatePrototype, virtualThreadsEnabled, virtualThreadsEnabled, virtualThreadsPinnedThreshold, virtualThreadsPinnedThreshold, warnOnMultipleRegistries, warnOnMultipleRegistries

Modifier and Type	Method	Description
MetricsConfig.Builder	addPublisher(MetricsPublisher publisher)	Metrics publishers which make the metrics data available to external systems.
MetricsConfig.Builder	addPublishers(List<? extends MetricsPublisher> publishers)	Metrics publishers which make the metrics data available to external systems.
MetricsConfig.Builder	addRoles(List<String> roles)	Role names allowed to access the metrics endpoint when this config is used by a metrics observer and MetricsConfig.BuilderBase.permitAll() is false.
MetricsConfig.Builder	addTags(List<? extends Tag> tags)	Global tags.
Optional<String>	appName()	Value for the application tag to be added to each meter ID.
MetricsConfig.Builder	appName(String appName)	Value for the application tag to be added to each meter ID.
Optional<String>	appTagName()	Name for the application tag to be added to each meter ID.
MetricsConfig.Builder	appTagName(String appTagName)	Name for the application tag to be added to each meter ID.
BuiltInMeterNameFormat	builtInMeterNameFormat()	Output format for built-in meter names.
MetricsConfig.Builder	builtInMeterNameFormat(BuiltInMeterNameFormat builtInMeterNameFormat)	Output format for built-in meter names.
MetricsConfig.Builder	clearAppName()	Clear existing value of appName.
MetricsConfig.Builder	clearAppTagName()	Clear existing value of appTagName.
MetricsConfig.Builder	clearJsonUnitsDefault()	Clear existing value of jsonUnitsDefault.
MetricsConfig.Builder	clearPublishers()	Clear all publishers.
MetricsConfig.Builder	clearRoles()	Clear all roles.
MetricsConfig.Builder	clearTags()	Clear all tags.
Optional<Config>	config()	Metrics configuration node.
MetricsConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	enabled()	Whether metrics functionality is enabled.
MetricsConfig.Builder	enabled(boolean enabled)	Whether metrics functionality is enabled.
MetricsConfig.Builder	from(MetricsConfig prototype)	Update this builder from an existing prototype instance.
MetricsConfig.Builder	from(MetricsConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<TimeUnit>	jsonUnitsDefault()	Default units for timer output in JSON if not specified on a given timer.
MetricsConfig.Builder	jsonUnitsDefault(TimeUnit jsonUnitsDefault)	Default units for timer output in JSON if not specified on a given timer.
Optional<KeyPerformanceIndicatorMetricsConfig>	keyPerformanceIndicatorMetricsConfig()	Key performance indicator metrics settings.
MetricsConfig.Builder	keyPerformanceIndicatorMetricsConfig(KeyPerformanceIndicatorMetricsConfig keyPerformanceIndicatorMetricsConfig)	Key performance indicator metrics settings.
MetricsConfig.Builder	keyPerformanceIndicatorMetricsConfig(Consumer<KeyPerformanceIndicatorMetricsConfig.Builder> consumer)	Key performance indicator metrics settings.
MetricsConfig.Builder	keyPerformanceIndicatorMetricsConfig(Supplier<? extends KeyPerformanceIndicatorMetricsConfig> supplier)	Key performance indicator metrics settings.
boolean	permitAll()	Whether to allow anybody to access the metrics endpoint when this config is used by a metrics observer.
MetricsConfig.Builder	permitAll(boolean permitAll)	Whether to allow anybody to access the metrics endpoint when this config is used by a metrics observer.
protected void	preBuildPrototype()	Handles providers and decorators.
List<MetricsPublisher>	publishers()	Metrics publishers which make the metrics data available to external systems.
MetricsConfig.Builder	publishers(List<? extends MetricsPublisher> publishers)	Metrics publishers which make the metrics data available to external systems.
boolean	publishersDiscoverServices()	Service discovery flag for MetricsConfig.BuilderBase.publishers().
MetricsConfig.Builder	publishersDiscoverServices(boolean publishersDiscoverServices)	Service discovery flag for MetricsConfig.BuilderBase.publishers().
boolean	restRequestEnabled()	Whether automatic REST request metrics should be measured.
MetricsConfig.Builder	restRequestEnabled(boolean restRequestEnabled)	Whether automatic REST request metrics should be measured.
List<String>	roles()	Role names allowed to access the metrics endpoint when this config is used by a metrics observer and MetricsConfig.BuilderBase.permitAll() is false.
MetricsConfig.Builder	roles(List<String> roles)	Role names allowed to access the metrics endpoint when this config is used by a metrics observer and MetricsConfig.BuilderBase.permitAll() is false.
Optional<ScopingConfig>	scoping()	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics ignores these settings, and this method will be removed.
MetricsConfig.Builder	scoping(ScopingConfig scoping)	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics ignores these settings, and this method will be removed.
MetricsConfig.Builder	scoping(Consumer<ScopingConfig.Builder> consumer)	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics ignores these settings, and this method will be removed.
MetricsConfig.Builder	scoping(Supplier<? extends ScopingConfig> supplier)	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics ignores these settings, and this method will be removed.
List<Tag>	tags()	Global tags.
MetricsConfig.Builder	tags(List<? extends Tag> tags)	Global tags.
String	toString()
protected void	validatePrototype()	Validates required properties.
boolean	virtualThreadsEnabled()	Whether Helidon should expose meters related to virtual threads.
MetricsConfig.Builder	virtualThreadsEnabled(boolean virtualThreadsEnabled)	Whether Helidon should expose meters related to virtual threads.
Duration	virtualThreadsPinnedThreshold()	Threshold for sampling pinned virtual threads to include in the pinned threads meter.
MetricsConfig.Builder	virtualThreadsPinnedThreshold(Duration virtualThreadsPinnedThreshold)	Threshold for sampling pinned virtual threads to include in the pinned threads meter.
boolean	warnOnMultipleRegistries()	Whether to log warnings when multiple registries are created.
MetricsConfig.Builder	warnOnMultipleRegistries(boolean warnOnMultipleRegistries)	Whether to log warnings when multiple registries are created.

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 MetricsConfig	get()
default MetricsConfig.Builder	identity()	Instance of this builder as the correct type.
default MetricsConfig.Builder	update(Consumer<MetricsConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public MetricsConfig 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<MetricsConfig.Builder, MetricsConfig>

Returns:

an instance of the setup object created from this builder

build

public MetricsConfig 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<MetricsConfig.Builder, MetricsConfig>

Returns:

instance of the built type