Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface MetricsSettings.Builder

All Superinterfaces:

Builder<MetricsSettings>, Supplier<MetricsSettings>

Enclosing interface:

MetricsSettings

public static interface MetricsSettings.Builder
extends Builder<MetricsSettings>

Builder for MetricsSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_CONFIG_KEY	Config key within the config metrics section controlling the base registry.
static String	DEFAULT_CONTEXT	Default web context for the metrics endpoint.
static String	ENABLED_CONFIG_KEY	Config key within the config metrics section controlling whether metrics are enabled.
static String	EXEMPLARS_STRICT_CONFIG_KEY	Config key within metrics for strict (vs.
static String	METRICS_CONFIG_KEY	The config key containing settings for all of metrics.
static String	REGISTRIES_CONFIG_KEY	Config key within the config metrics section containing settings for individual registries.

Method Summary

Modifier and Type	Method	Description
MetricsSettings.Builder	baseMetricsSettings(BaseMetricsSettings.Builder baseMetricsSettingsBuilder)	Set the base metrics settings.
MetricsSettings	build()	Constructs a MetricsSettings object from the builder.
MetricsSettings.Builder	config(Config config)	Updates the builder using the provided metrics config.
MetricsSettings.Builder	enabled(boolean value)	Sets whether metrics should be enabled.
MetricsSettings.Builder	keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder kpiSettings)	Set the KPI metrics settings.
MetricsSettings.Builder	registrySettings(MetricRegistry.Type registryType, RegistrySettings registrySettings)	Sets the registry settings for the specified registry type.

Methods inherited from interface io.helidon.common.Builder

get

Field Detail

ENABLED_CONFIG_KEY

static final String ENABLED_CONFIG_KEY

Config key within the config metrics section controlling whether metrics are enabled.

See Also:

Constant Field Values

METRICS_CONFIG_KEY

static final String METRICS_CONFIG_KEY

The config key containing settings for all of metrics.

See Also:

Constant Field Values

BASE_CONFIG_KEY

static final String BASE_CONFIG_KEY

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

See Also:

Constant Field Values

REGISTRIES_CONFIG_KEY

static final String REGISTRIES_CONFIG_KEY

Config key within the config metrics section containing settings for individual registries.

See Also:

Constant Field Values

DEFAULT_CONTEXT

static final String DEFAULT_CONTEXT

Default web context for the metrics endpoint.

See Also:

Constant Field Values

EXEMPLARS_STRICT_CONFIG_KEY

static final String EXEMPLARS_STRICT_CONFIG_KEY

Config key within metrics for strict (vs. lax) exemplar behavior.

See Also:

Constant Field Values

Method Detail

build

MetricsSettings build()

Constructs a MetricsSettings object from the builder.

Specified by:

build in interface Builder<MetricsSettings>

Returns:

new settings instance based on the builder

enabled

MetricsSettings.Builder enabled(boolean value)

Sets whether metrics should be enabled.

Parameters:

value - true if metrics should be enabled; false if not

Returns:

updated builder

config

MetricsSettings.Builder config(Config config)

Updates the builder using the provided metrics config.

Parameters:

config - the component's or the overall metrics config from the configuration

Returns:

updated builder

keyPerformanceIndicatorSettings

MetricsSettings.Builder keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder kpiSettings)

Set the KPI metrics settings.

Parameters:

kpiSettings - key performance indicator metrics settings to use

Returns:

updated builder

baseMetricsSettings

MetricsSettings.Builder baseMetricsSettings(BaseMetricsSettings.Builder baseMetricsSettingsBuilder)

Set the base metrics settings.

Parameters:

baseMetricsSettingsBuilder - base metrics settings to use

Returns:

updated builder

registrySettings

MetricsSettings.Builder registrySettings(MetricRegistry.Type registryType,
                                         RegistrySettings registrySettings)

Sets the registry settings for the specified registry type.

Parameters:

registryType - type of registry for which to assign settings

registrySettings - assigned registry settings

Returns:

updated builder