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

Interface RegistrySettings

public interface RegistrySettings
Settings which control metrics within registries (application, vendor, base) as a group or individually.

Application code can control the metrics of each registry type as a whole, enabling or disabling all metrics of the type using RegistrySettings.Builder.enabled(boolean) as well as selectively enabling or disabling specific metrics using RegistrySettings.Builder.filterSettings(io.helidon.metrics.api.RegistryFilterSettings.Builder).

Callers can also pass a Config object to builder or static factory methods as well.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RegistrySettings.Builder
    Builder for RegistrySettings.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RegistrySettings.Builder
    builder()
    Creates a new defaulted builder for RegistrySettings.
    static RegistrySettings
    create()
    Creates a new default RegistrySettings instance.
    static RegistrySettings
    create(Config registrySettings)
    Creates a new RegistrySettings instance using the provided config.
    boolean
    isEnabled()
    Returns whether metrics of this type are enabled.
    boolean
    isMetricEnabled(String dottedName)
    Returns whether the specified metric name is enabled or not, factoring in the enabled setting for this type as a whole with the regex pattern.
    boolean
    isStrictExemplars()
    Returns whether strict exemplar behavior is enabled.

  • Method Details

    • create

      static RegistrySettings create()
      Creates a new default RegistrySettings instance.
      Returns:
      new default instance

    • create

      static RegistrySettings create(Config registrySettings)
      Creates a new RegistrySettings instance using the provided config.
      Parameters:
      registrySettings - the config node for the registry's settings
      Returns:
      updated builder

    • builder

      static RegistrySettings.Builder builder()
      Creates a new defaulted builder for RegistrySettings.
      Returns:
      new builder with default values

    • isEnabled

      boolean isEnabled()
      Returns whether metrics of this type are enabled.
      Returns:
      true if metrics of this type are enabled as a whole; false otherwise

    • isStrictExemplars

      boolean isStrictExemplars()
      Returns whether strict exemplar behavior is enabled.
      Returns:
      true/false

    • isMetricEnabled

      boolean isMetricEnabled(String dottedName)
      Returns whether the specified metric name is enabled or not, factoring in the enabled setting for this type as a whole with the regex pattern.
      Parameters:
      dottedName - name of the metric to check
      Returns:
      true if the specified metric should be full-featured; false otherwise