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