Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface ComponentMetricsSettings.Builder

All Superinterfaces:

Builder<ComponentMetricsSettings.Builder,ComponentMetricsSettings>, Supplier<ComponentMetricsSettings>

Enclosing interface:

ComponentMetricsSettings

public static interface ComponentMetricsSettings.Builder
extends Builder<ComponentMetricsSettings.Builder,ComponentMetricsSettings>

Builder for ComponentMetricsSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_CONFIG_KEY	Config key within the component's metrics config section controlling whether metrics are enabled for that component.
static final String	METRICS_CONFIG_KEY	By convention, the config key within the component's config section containing metrics settings for the component.

Method Summary

Modifier and Type	Method	Description
ComponentMetricsSettings	build()	Constructs a ComponentMetricsSettings object from the builder.
default ComponentMetricsSettings.Builder	config(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. use config(io.helidon.config.Config) instead
default ComponentMetricsSettings.Builder	config(Config config)	Updates the builder using the provided metrics config.
ComponentMetricsSettings.Builder	enabled(boolean value)	Sets whether metrics should be enabled for the component.

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Field Details

METRICS_CONFIG_KEY

static final String METRICS_CONFIG_KEY

By convention, the config key within the component's config section containing metrics settings for the component.

See Also:

• Constant Field Values

ENABLED_CONFIG_KEY

static final String ENABLED_CONFIG_KEY

Config key within the component's metrics config section controlling whether metrics are enabled for that component.

See Also:

• Constant Field Values

Method Details

build

ComponentMetricsSettings build()

Constructs a ComponentMetricsSettings object from the builder.

Specified by:

build in interface Builder<ComponentMetricsSettings.Builder,ComponentMetricsSettings>

Returns:

new settings instance based on the builder

enabled

ComponentMetricsSettings.Builder enabled(boolean value)

Sets whether metrics should be enabled for the component.

Parameters:

value - true if metrics should be enabled for the component; false if not

Returns:

updated builder

config

@Deprecated(since="4.4.0",
            forRemoval=true)
default ComponentMetricsSettings.Builder config(Config config)

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

use config(io.helidon.config.Config) instead

Updates the builder using the provided metrics config.

Parameters:

config - the component's metrics config section

Returns:

updated builder

config

default ComponentMetricsSettings.Builder config(Config config)

Updates the builder using the provided metrics config.

Parameters:

config - the component's metrics config section

Returns:

updated builder