Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface KeyPerformanceIndicatorMetricsConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl

public interface KeyPerformanceIndicatorMetricsConfig
extends Prototype.Api

Config bean for KPI metrics configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KeyPerformanceIndicatorMetricsConfig.Builder	Fluent API builder for KeyPerformanceIndicatorMetricsConfig.
static class	KeyPerformanceIndicatorMetricsConfig.BuilderBase<BUILDER extends KeyPerformanceIndicatorMetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends KeyPerformanceIndicatorMetricsConfig>	Fluent API builder base for KeyPerformanceIndicatorMetricsConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LONG_RUNNING_REQUESTS_THRESHOLD_DEFAULT	Default long-running requests threshold.

Method Summary

Modifier and Type	Method	Description
static KeyPerformanceIndicatorMetricsConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static KeyPerformanceIndicatorMetricsConfig.Builder	builder(KeyPerformanceIndicatorMetricsConfig instance)	Create a new fluent API builder from an existing instance.
static KeyPerformanceIndicatorMetricsConfig	create()	Create a new instance with default values.
static KeyPerformanceIndicatorMetricsConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static KeyPerformanceIndicatorMetricsConfig	create(Config config)	Create a new instance from configuration.
boolean	extended()	Whether KPI extended metrics are enabled.
Duration	longRunningRequestThreshold()	Threshold in ms that characterizes whether a request is long running.

Field Details

LONG_RUNNING_REQUESTS_THRESHOLD_DEFAULT

static final String LONG_RUNNING_REQUESTS_THRESHOLD_DEFAULT

Default long-running requests threshold.

See Also:

• Constant Field Values

Method Details

builder

static KeyPerformanceIndicatorMetricsConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static KeyPerformanceIndicatorMetricsConfig.Builder builder(KeyPerformanceIndicatorMetricsConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static KeyPerformanceIndicatorMetricsConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static KeyPerformanceIndicatorMetricsConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static KeyPerformanceIndicatorMetricsConfig create()

Create a new instance with default values.

Returns:

a new instance

extended

boolean extended()

Whether KPI extended metrics are enabled.

Returns:

true if KPI extended metrics are enabled; false otherwise

longRunningRequestThreshold

Duration longRunningRequestThreshold()

Threshold in ms that characterizes whether a request is long running.

Returns:

threshold in ms indicating a long-running request