Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface BaseMetricsSettings.Builder

All Superinterfaces:

Builder<BaseMetricsSettings>, Supplier<BaseMetricsSettings>

Enclosing interface:

BaseMetricsSettings

public static interface BaseMetricsSettings.Builder
extends Builder<BaseMetricsSettings>

Builder for BaseMetricsSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_METRICS_CONFIG_KEY	Config key within the config metrics section controlling base metrics behavior.
static String	ENABLED_CONFIG_KEY	Config key within the config {code metrics.base} section controlling whether base metrics should be enabled.

Method Summary

Modifier and Type	Method	Description
BaseMetricsSettings.Builder	config(Config baseMetricsConfig)	Sets values in the builder based on the provided Config node.
BaseMetricsSettings.Builder	enableBaseMetric(String dottedName, boolean value)	Sets whether a specific base metric should be enabled.
BaseMetricsSettings.Builder	enabled(boolean value)	Sets whether base metrics should be enabled.
boolean	isEnabled()

Methods inherited from interface io.helidon.common.Builder

build, get

Field Detail

BASE_METRICS_CONFIG_KEY

static final String BASE_METRICS_CONFIG_KEY

Config key within the config metrics section controlling base metrics behavior.

See Also:

Constant Field Values

ENABLED_CONFIG_KEY

static final String ENABLED_CONFIG_KEY

Config key within the config {code metrics.base} section controlling whether base metrics should be enabled.

See Also:

Constant Field Values

Method Detail

enabled

BaseMetricsSettings.Builder enabled(boolean value)

Sets whether base metrics should be enabled.

Parameters:

value - true if base metrics should be enabled; false otherwise

Returns:

updated builder

config

BaseMetricsSettings.Builder config(Config baseMetricsConfig)

Sets values in the builder based on the provided Config node.

Parameters:

baseMetricsConfig - Config node contain base metrics settings

Returns:

updated builder

enableBaseMetric

BaseMetricsSettings.Builder enableBaseMetric(String dottedName,
                                             boolean value)

Sets whether a specific base metric should be enabled.

Parameters:

dottedName - the dotted name (e.g., memory.usedHeap for the base metric

value - whether that base metric should be enabled or not

Returns:

updated builder

isEnabled

boolean isEnabled()

Returns:

builder's current setting for whether base metrics are to be used