Module io.helidon.metrics.api

Package io.helidon.metrics.api

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

java.lang.Object

io.helidon.metrics.api.MetricsConfig.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>

Direct Known Subclasses:

MetricsConfig.Builder

Enclosing interface:

MetricsConfig

public abstract static class MetricsConfig.BuilderBase<BUILDER extends MetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsConfig>
extends Object
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for MetricsConfig.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BUILDER	addRoles(List<String> roles)	Hints for role names the user is expected to be in.
BUILDER	addTags(List<? extends Tag> tags)	Global tags.
Optional<String>	appName()	Value for the application tag to be added to each meter ID.
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.
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.
BUILDER	builtInMeterNameFormat(BuiltInMeterNameFormat builtInMeterNameFormat)	Output format for built-in meter names.
BUILDER	clearAppName()	Clear existing value of this property.
BUILDER	clearAppTagName()	Clear existing value of this property.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
boolean	enabled()	Whether metrics functionality is enabled.
BUILDER	enabled(boolean enabled)	Whether metrics functionality is enabled.
BUILDER	from(MetricsConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(MetricsConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
GcTimeType	gcTimeType()	Deprecated, for removal: This API element is subject to removal in a future version. Provided for backward compatibility only; no replacement
BUILDER	gcTimeType(GcTimeType gcTimeType)	Deprecated, for removal: This API element is subject to removal in a future version. Provided for backward compatibility only; no replacement
Optional<KeyPerformanceIndicatorMetricsConfig>	keyPerformanceIndicatorMetricsConfig()	Key performance indicator metrics settings.
BUILDER	keyPerformanceIndicatorMetricsConfig(KeyPerformanceIndicatorMetricsConfig keyPerformanceIndicatorMetricsConfig)	Key performance indicator metrics settings.
BUILDER	keyPerformanceIndicatorMetricsConfig(Consumer<KeyPerformanceIndicatorMetricsConfig.Builder> consumer)	Key performance indicator metrics settings.
BUILDER	keyPerformanceIndicatorMetricsConfig(Supplier<? extends KeyPerformanceIndicatorMetricsConfig> supplier)	Key performance indicator metrics settings.
boolean	permitAll()	Whether to allow anybody to access the endpoint.
BUILDER	permitAll(boolean permitAll)	Whether to allow anybody to access the endpoint.
protected void	preBuildPrototype()	Handles providers and decorators.
boolean	restRequestEnabled()	Whether automatic REST request metrics should be measured.
BUILDER	restRequestEnabled(boolean restRequestEnabled)	Whether automatic REST request metrics should be measured.
List<String>	roles()	Hints for role names the user is expected to be in.
BUILDER	roles(List<String> roles)	Hints for role names the user is expected to be in.
Optional<ScopingConfig>	scoping()	Settings related to scoping management.
BUILDER	scoping(ScopingConfig scoping)	Settings related to scoping management.
BUILDER	scoping(Consumer<ScopingConfig.Builder> consumer)	Settings related to scoping management.
BUILDER	scoping(Supplier<? extends ScopingConfig> supplier)	Settings related to scoping management.
List<Tag>	tags()	Global tags.
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.
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.
BUILDER	virtualThreadsPinnedThreshold(Duration virtualThreadsPinnedThreshold)	Threshold for sampling pinned virtual threads to include in the pinned threads meter.

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(MetricsConfig 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(MetricsConfig.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

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 MetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsConfig>

Parameters:

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

Returns:

updated builder instance

enabled

public BUILDER enabled(boolean enabled)

Whether metrics functionality is enabled.

Parameters:

enabled - if metrics are configured to be enabled

Returns:

updated builder instance

See Also:

• enabled()

permitAll

public BUILDER permitAll(boolean permitAll)

Whether to allow anybody to access the endpoint.

Parameters:

permitAll - whether to permit access to metrics endpoint to anybody, defaults to true

Returns:

updated builder instance

See Also:

• roles()
• permitAll()

roles

public BUILDER roles(List<String> roles)

Hints for role names the user is expected to be in.

Parameters:

roles - list of hints

Returns:

updated builder instance

See Also:

• roles()

addRoles

public BUILDER addRoles(List<String> roles)

Hints for role names the user is expected to be in.

Parameters:

roles - list of hints

Returns:

updated builder instance

See Also:

• roles()

keyPerformanceIndicatorMetricsConfig

public BUILDER keyPerformanceIndicatorMetricsConfig(KeyPerformanceIndicatorMetricsConfig keyPerformanceIndicatorMetricsConfig)

Key performance indicator metrics settings.

Parameters:

keyPerformanceIndicatorMetricsConfig - key performance indicator metrics settings

Returns:

updated builder instance

See Also:

• keyPerformanceIndicatorMetricsConfig()

keyPerformanceIndicatorMetricsConfig

public BUILDER keyPerformanceIndicatorMetricsConfig(Consumer<KeyPerformanceIndicatorMetricsConfig.Builder> consumer)

Key performance indicator metrics settings.

Parameters:

consumer - consumer of builder for key performance indicator metrics settings

Returns:

updated builder instance

See Also:

• keyPerformanceIndicatorMetricsConfig()

keyPerformanceIndicatorMetricsConfig

public BUILDER keyPerformanceIndicatorMetricsConfig(Supplier<? extends KeyPerformanceIndicatorMetricsConfig> supplier)

Key performance indicator metrics settings.

Parameters:

supplier - supplier of key performance indicator metrics settings

Returns:

updated builder instance

See Also:

• keyPerformanceIndicatorMetricsConfig()

tags

public BUILDER tags(List<? extends Tag> tags)

Global tags.

Parameters:

tags - name/value pairs for global tags

Returns:

updated builder instance

See Also:

• tags()

addTags

public BUILDER addTags(List<? extends Tag> tags)

Global tags.

Parameters:

tags - name/value pairs for global tags

Returns:

updated builder instance

See Also:

• tags()

clearAppName

public BUILDER clearAppName()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• appName()

appName

public BUILDER appName(String appName)

Value for the application tag to be added to each meter ID.

Parameters:

appName - application tag value

Returns:

updated builder instance

See Also:

• appName()

clearAppTagName

public BUILDER clearAppTagName()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• appTagName()

appTagName

public BUILDER appTagName(String appTagName)

Name for the application tag to be added to each meter ID.

Parameters:

appTagName - application tag name

Returns:

updated builder instance

See Also:

• appTagName()

scoping

public BUILDER scoping(ScopingConfig scoping)

Settings related to scoping management.

Parameters:

scoping - scoping settings

Returns:

updated builder instance

See Also:

• scoping()

scoping

public BUILDER scoping(Consumer<ScopingConfig.Builder> consumer)

Settings related to scoping management.

Parameters:

consumer - consumer of builder for scoping settings

Returns:

updated builder instance

See Also:

• scoping()

scoping

public BUILDER scoping(Supplier<? extends ScopingConfig> supplier)

Settings related to scoping management.

Parameters:

supplier - supplier of scoping settings

Returns:

updated builder instance

See Also:

• scoping()

restRequestEnabled

public BUILDER restRequestEnabled(boolean restRequestEnabled)

Whether automatic REST request metrics should be measured.

Parameters:

restRequestEnabled - true/false

Returns:

updated builder instance

See Also:

• restRequestEnabled()

virtualThreadsEnabled

public BUILDER virtualThreadsEnabled(boolean virtualThreadsEnabled)

Whether Helidon should expose meters related to virtual threads.

Parameters:

virtualThreadsEnabled - true to include meters related to virtual threads

Returns:

updated builder instance

See Also:

• virtualThreadsEnabled()

virtualThreadsPinnedThreshold

public BUILDER virtualThreadsPinnedThreshold(Duration virtualThreadsPinnedThreshold)

Threshold for sampling pinned virtual threads to include in the pinned threads meter.

Parameters:

virtualThreadsPinnedThreshold - threshold used to filter virtual thread pinning events

Returns:

updated builder instance

See Also:

• virtualThreadsPinnedThreshold()

gcTimeType

@Deprecated(since="4.1",
            forRemoval=true)
public BUILDER gcTimeType(GcTimeType gcTimeType)

Deprecated, for removal: This API element is subject to removal in a future version.

Provided for backward compatibility only; no replacement

Whether the gc.time meter should be registered as a gauge (vs. a counter). The gc.time meter is inspired by the MicroProfile Metrics spec, in which the meter was originally checked to be a counter but starting in 5.1 was checked be a gauge. For the duration of Helidon 4.x users can choose which type of meter Helidon registers for gc.time.

Parameters:

gcTimeType - the type of meter to use for registering gc.time

Returns:

updated builder instance

See Also:

• gcTimeType()

builtInMeterNameFormat

public BUILDER builtInMeterNameFormat(BuiltInMeterNameFormat builtInMeterNameFormat)

Output format for built-in meter names.

BuiltInMeterNameFormat.SNAKE selects "snake_case" which does not conform to the MicroProfile Metrics specification.

Parameters:

builtInMeterNameFormat - the output format for built-in meter names

Returns:

updated builder instance

See Also:

• builtInMeterNameFormat()

enabled

public boolean enabled()

Whether metrics functionality is enabled.

Returns:

the enabled

permitAll

public boolean permitAll()

Whether to allow anybody to access the endpoint.

Returns:

the permit all

See Also:

• roles()
• permitAll()

roles

public List<String> roles()

Hints for role names the user is expected to be in.

Returns:

the roles

keyPerformanceIndicatorMetricsConfig

public Optional<KeyPerformanceIndicatorMetricsConfig> keyPerformanceIndicatorMetricsConfig()

Key performance indicator metrics settings.

Returns:

the key performance indicator metrics config

tags

public List<Tag> tags()

Global tags.

Returns:

the tags

appName

public Optional<String> appName()

Value for the application tag to be added to each meter ID.

Returns:

the app name

appTagName

public Optional<String> appTagName()

Name for the application tag to be added to each meter ID.

Returns:

the app tag name

scoping

public Optional<ScopingConfig> scoping()

Settings related to scoping management.

Returns:

the scoping

restRequestEnabled

public boolean restRequestEnabled()

Whether automatic REST request metrics should be measured.

Returns:

the rest request enabled

virtualThreadsEnabled

public boolean virtualThreadsEnabled()

Whether Helidon should expose meters related to virtual threads.

Returns:

the virtual threads enabled

virtualThreadsPinnedThreshold

public Duration virtualThreadsPinnedThreshold()

Threshold for sampling pinned virtual threads to include in the pinned threads meter.

Returns:

the virtual threads pinned threshold

gcTimeType

@Deprecated(since="4.1",
            forRemoval=true)
public GcTimeType gcTimeType()

Deprecated, for removal: This API element is subject to removal in a future version.

Provided for backward compatibility only; no replacement

Whether the gc.time meter should be registered as a gauge (vs. a counter). The gc.time meter is inspired by the MicroProfile Metrics spec, in which the meter was originally checked to be a counter but starting in 5.1 was checked be a gauge. For the duration of Helidon 4.x users can choose which type of meter Helidon registers for gc.time.

Returns:

the gc time type

builtInMeterNameFormat

public BuiltInMeterNameFormat builtInMeterNameFormat()

Output format for built-in meter names.

BuiltInMeterNameFormat.SNAKE selects "snake_case" which does not conform to the MicroProfile Metrics specification.

Returns:

the built in meter name format

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class Object

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

validatePrototype

protected void validatePrototype()

Validates required properties.