public interface ComponentMetricsSettings
Settings which control metrics behavior for a metrics-capable component.
Do not use this for controlling overall metrics. Use MetricsConfig instead.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceBuilder forComponentMetricsSettings. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Returns a builder forComponentMetricsSettings.builder(io.helidon.common.config.Config componentMetricsConfig) Returns a builder forComponentMetricsSettingsbased on the provided component metric settings config node.static ComponentMetricsSettingscreate(io.helidon.common.config.Config config) Returns component metrics settings created from aConfignode, by convention themetricsconfig section within the component's own config section.booleanReturns whether the component settings indicate that metrics are enabled for the component.
-
Method Details
-
create
Returns component metrics settings created from aConfignode, by convention themetricsconfig section within the component's own config section.Equivalent to
ComponentMetricsSettings.builder().config(config).build().- Parameters:
config- the metrics config section within the component's configuration- Returns:
- new settings reflecting the config, using defaults as needed
-
builder
Returns a builder forComponentMetricsSettings.- Returns:
- new builder
-
builder
static ComponentMetricsSettings.Builder builder(io.helidon.common.config.Config componentMetricsConfig) Returns a builder forComponentMetricsSettingsbased on the provided component metric settings config node.- Parameters:
componentMetricsConfig- the config node containing the component metrics config section- Returns:
- new builder initialized with the config settings
-
isEnabled
boolean isEnabled()Returns whether the component settings indicate that metrics are enabled for the component.- Returns:
- whether metrics are enabled for the component according to the settings
-