Module io.helidon.metrics.api
Package io.helidon.metrics.api
Interface KeyPerformanceIndicatorMetricsSettings
-
public interface KeyPerformanceIndicatorMetricsSettingsSettings for key performance indicator (KPI) metrics.The Helidon SE and MP metrics guides describe the KPI metrics and how to control them using config and this settings interface.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceKeyPerformanceIndicatorMetricsSettings.BuilderOverride default settings.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static KeyPerformanceIndicatorMetricsSettings.Builderbuilder()Creates a new builder for the settings.static KeyPerformanceIndicatorMetricsSettings.Builderbuilder(KeyPerformanceIndicatorMetricsSettings kpiMetricsSettings)Creates a builder using the values from an existingKeyPerformanceIndicatorMetricsSettingsinstance.static KeyPerformanceIndicatorMetricsSettingscreate(Config kpiConfig)Creates a newKeyPerformanceIndicatorMetricsSettingsinstance from the specified config node containing KPI metrics settings.booleanisExtended()longlongRunningRequestThresholdMs()
-
-
-
Method Detail
-
create
static KeyPerformanceIndicatorMetricsSettings create(Config kpiConfig)
Creates a newKeyPerformanceIndicatorMetricsSettingsinstance from the specified config node containing KPI metrics settings.- Parameters:
kpiConfig- config node containing KPI metrics settings- Returns:
- new KPI metrics settings reflecting the config
-
builder
static KeyPerformanceIndicatorMetricsSettings.Builder builder()
Creates a new builder for the settings.- Returns:
- new
KeyPerformanceIndicatorMetricsSettings.Builder
-
builder
static KeyPerformanceIndicatorMetricsSettings.Builder builder(KeyPerformanceIndicatorMetricsSettings kpiMetricsSettings)
Creates a builder using the values from an existingKeyPerformanceIndicatorMetricsSettingsinstance.- Parameters:
kpiMetricsSettings- existing KPI metrics settings to copy- Returns:
- new
Builderinitialized according to the provide settings
-
isExtended
boolean isExtended()
- Returns:
- whether extended KPI metrics are enabled in the settings
-
longRunningRequestThresholdMs
long longRunningRequestThresholdMs()
- Returns:
- the threshold (in ms) for long-running requests
-
-