-
public interface ComponentMetricsSettings
Settings which control metrics behavior for a metrics-capable component.Do not use this for controlling overall metrics. Use
MetricsSettings
instead.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ComponentMetricsSettings.Builder
Builder forComponentMetricsSettings
.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static ComponentMetricsSettings.Builder
builder()
Returns a builder forComponentMetricsSettings
.static ComponentMetricsSettings.Builder
builder(Config componentMetricsConfig)
Returns a builder forComponentMetricsSettings
based on the provided component metric settings config node.static ComponentMetricsSettings
create(Config config)
Returns component metrics settings created from aConfig
node, by convention themetrics
config section within the component's own config section.boolean
isEnabled()
-
-
-
Method Detail
-
create
static ComponentMetricsSettings create(Config config)
Returns component metrics settings created from aConfig
node, by convention themetrics
config 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
static ComponentMetricsSettings.Builder builder()
Returns a builder forComponentMetricsSettings
.- Returns:
- new builder
-
builder
static ComponentMetricsSettings.Builder builder(Config componentMetricsConfig)
Returns a builder forComponentMetricsSettings
based 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 metrics are enabled for the component according to the settings
-
-