Module io.helidon.metrics.api
Package io.helidon.metrics.api

Interface ComponentMetricsSettings

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 Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ComponentMetricsSettings.Builder
    Builder for ComponentMetricsSettings.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ComponentMetricsSettings.Builder
    builder()
    Returns a builder for ComponentMetricsSettings.
    static ComponentMetricsSettings.Builder
    builder(Config componentMetricsConfig)
    Returns a builder for ComponentMetricsSettings based on the provided component metric settings config node.
    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.
    boolean
    isEnabled()
    Returns whether the component settings indicate that metrics are enabled for the component.

  • 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().

      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 for ComponentMetricsSettings.
      Returns:
      new builder

    • builder

      static ComponentMetricsSettings.Builder builder(Config componentMetricsConfig)
      Returns a builder for ComponentMetricsSettings 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 the component settings indicate that metrics are enabled for the component.
      Returns:
      whether metrics are enabled for the component according to the settings