Interface ComponentMetricsSettings

public interface ComponentMetricsSettings
Settings which control metrics behavior for a metrics-capable component.

Do not use this for controlling overall metrics. Use MetricsSettings instead.

  • Method Details

    • create

      static ComponentMetricsSettings create(Config config)
      Returns component metrics settings created from a Config node, by convention the metrics config section within the component's own config section.

      Equivalent to ComponentMetricsSettings.builder().config(config).build().

      config - the metrics config section within the component's configuration
      new settings reflecting the config, using defaults as needed
    • builder

      Returns a builder for ComponentMetricsSettings.
      new builder
    • builder

      static ComponentMetricsSettings.Builder builder(Config componentMetricsConfig)
      Returns a builder for ComponentMetricsSettings based on the provided component metric settings config node.
      componentMetricsConfig - the config node containing the component metrics config section
      new builder initialized with the config settings
    • isEnabled

      boolean isEnabled()
      whether metrics are enabled for the component according to the settings