Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface KeyPerformanceIndicatorMetricsSettings.Builder

All Superinterfaces:

Builder<KeyPerformanceIndicatorMetricsSettings.Builder,KeyPerformanceIndicatorMetricsSettings>, Supplier<KeyPerformanceIndicatorMetricsSettings>

All Known Subinterfaces:

KeyPerformanceIndicatorMetricsSettings.Builder

Enclosing interface:

KeyPerformanceIndicatorMetricsSettings

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

Override default settings.

Configuration options:

Key performance indicator metrics configuration ("metrics.key-performance-indicators"

Key	Default	Description	Builder method
"extended"	false	Whether the extended key performance indicator metrics should be enabled	extended(boolean)
"threshold-ms"	10000L	Threshold (in milliseconds) for long-running requests	longRunningRequestThresholdMs(long)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_PREFIX	Prefix of configuration keys.
static final String	KEY_PERFORMANCE_INDICATORS_CONFIG_KEY	Config key for extended key performance indicator metrics settings.
static final String	KEY_PERFORMANCE_INDICATORS_EXTENDED_CONFIG_KEY	Config key for enabled setting of the extended KPI metrics.
static final boolean	KEY_PERFORMANCE_INDICATORS_EXTENDED_DEFAULT	Default enabled setting for extended KPI metrics.
static final String	LONG_RUNNING_REQUESTS_CONFIG_KEY	Config key for long-running requests settings.
static final String	LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY	Config key for long-running requests threshold setting (in milliseconds).
static final long	LONG_RUNNING_REQUESTS_THRESHOLD_MS_DEFAULT	Default long-running requests threshold.
static final String	QUALIFIED_LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY	Configuration key for long-running requests extended configuration.

Method Summary

Modifier and Type	Method	Description
KeyPerformanceIndicatorMetricsSettings	build()	Builds a KeyPerformanceIndicatorMetricsSettings using the settings from the builder.
KeyPerformanceIndicatorMetricsSettings.Builder	config(Config kpiConfig)	Updates the KPI metrics settings in the builder based on the provided Config object.
KeyPerformanceIndicatorMetricsSettings.Builder	extended(boolean value)	Sets whether exntended KPI metrics should be enabled in the settings.
boolean	isExtended()	Whether extended KPIs are enabled.
long	longRunningRequestThresholdMs()	Threshold (in milliseconds) for long-running requests.
KeyPerformanceIndicatorMetricsSettings.Builder	longRunningRequestThresholdMs(long value)	Sets the long-running request threshold (in ms).

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Field Details

KEY_PERFORMANCE_INDICATORS_CONFIG_KEY

static final String KEY_PERFORMANCE_INDICATORS_CONFIG_KEY

Config key for extended key performance indicator metrics settings.

See Also:

• Constant Field Values

KEY_PERFORMANCE_INDICATORS_EXTENDED_CONFIG_KEY

static final String KEY_PERFORMANCE_INDICATORS_EXTENDED_CONFIG_KEY

Config key for enabled setting of the extended KPI metrics.

See Also:

• Constant Field Values

KEY_PERFORMANCE_INDICATORS_EXTENDED_DEFAULT

static final boolean KEY_PERFORMANCE_INDICATORS_EXTENDED_DEFAULT

Default enabled setting for extended KPI metrics.

See Also:

• Constant Field Values

LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY

static final String LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY

Config key for long-running requests threshold setting (in milliseconds).

See Also:

• Constant Field Values

LONG_RUNNING_REQUESTS_CONFIG_KEY

static final String LONG_RUNNING_REQUESTS_CONFIG_KEY

Config key for long-running requests settings.

See Also:

• Constant Field Values

LONG_RUNNING_REQUESTS_THRESHOLD_MS_DEFAULT

static final long LONG_RUNNING_REQUESTS_THRESHOLD_MS_DEFAULT

Default long-running requests threshold.

See Also:

• Constant Field Values

CONFIG_KEY_PREFIX

static final String CONFIG_KEY_PREFIX

Prefix of configuration keys.

See Also:

• Constant Field Values

QUALIFIED_LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY

static final String QUALIFIED_LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY

Configuration key for long-running requests extended configuration.

See Also:

• Constant Field Values

Method Details

extended

KeyPerformanceIndicatorMetricsSettings.Builder extended(boolean value)

Sets whether exntended KPI metrics should be enabled in the settings.

Parameters:

value - whether extended KPI metrics should be enabled

Returns:

updated builder instance

longRunningRequestThresholdMs

KeyPerformanceIndicatorMetricsSettings.Builder longRunningRequestThresholdMs(long value)

Sets the long-running request threshold (in ms).

Parameters:

value - long-running request threshold

Returns:

updated builder instance

config

KeyPerformanceIndicatorMetricsSettings.Builder config(Config kpiConfig)

Updates the KPI metrics settings in the builder based on the provided Config object.

Parameters:

kpiConfig - KPI metrics config node

Returns:

updated builder instance

build

KeyPerformanceIndicatorMetricsSettings build()

Builds a KeyPerformanceIndicatorMetricsSettings using the settings from the builder.

Specified by:

build in interface Builder<KeyPerformanceIndicatorMetricsSettings.Builder,KeyPerformanceIndicatorMetricsSettings>

Returns:

KeyPerformanceIndicatorMetricsSettings prepared according to the builder

isExtended

boolean isExtended()

Whether extended KPIs are enabled.

Returns:

true if extended

longRunningRequestThresholdMs

long longRunningRequestThresholdMs()

Threshold (in milliseconds) for long-running requests.

Returns:

threshold in milliseconds