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

Interface MetricsProgrammaticConfig

All Known Implementing Classes:
MpMetricsProgrammaticConfig
public interface MetricsProgrammaticConfig
Programmatic (rather than user-configurable) settings that govern certain metrics behavior.

Implementations of this interface are typically provided by Helidon itself rather than developers building applications and are not intended for per-deployment (or even per-application) customization.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    MetricsProgrammaticConfig.Instance
    Internal use class to hold a reference to the singleton.

  • Method Summary

    Modifier and Type
    Method
    Description
    default io.helidon.metrics.api.MetricsConfig
    apply(io.helidon.metrics.api.MetricsConfig metricsConfig)
    Creates a new MetricsConfig instance by applying overrides from this programmatic config instance.
    default io.helidon.metrics.api.MetricsConfig.Builder
    apply(io.helidon.metrics.api.MetricsConfig.Builder builder)
    Augments an existing MetricsConfig.Builder, presumably from actual config, with overrides provided by this programmatic config instance.
    default Optional<String>
    appTagName()
    Name to use for a tag, added to each meter's identity, conveying the application it belongs to.
    static MetricsProgrammaticConfig
    instance()
    Returns the singleton instance of the metrics programmatic settings.
    default Set<String>
    reservedTagNames()
    Returns the reserved tag names (for scope and app).
    default Optional<String>
    scopeDefaultValue()
    Default tag value to use for the scope tag if none is specified when the meter ID is created.
    default Optional<String>
    scopeTagName()
    Name to use for a tag, added to each meter's identity, conveying its scope in output.

  • Method Details

    • instance

      static MetricsProgrammaticConfig instance()
      Returns the singleton instance of the metrics programmatic settings.
      Returns:
      the singleton

    • scopeDefaultValue

      default Optional<String> scopeDefaultValue()
      Default tag value to use for the scope tag if none is specified when the meter ID is created.
      Returns:
      default scope tag value

    • scopeTagName

      default Optional<String> scopeTagName()
      Name to use for a tag, added to each meter's identity, conveying its scope in output.
      Returns:
      the scope tag name

    • appTagName

      default Optional<String> appTagName()
      Name to use for a tag, added to each meter's identity, conveying the application it belongs to.
      Returns:
      the app tag name

    • reservedTagNames

      default Set<String> reservedTagNames()
      Returns the reserved tag names (for scope and app).
      Returns:
      reserved tag names

    • apply

      default io.helidon.metrics.api.MetricsConfig.Builder apply(io.helidon.metrics.api.MetricsConfig.Builder builder)
      Augments an existing MetricsConfig.Builder, presumably from actual config, with overrides provided by this programmatic config instance.
      Parameters:
      builder - original metrics configuration builder
      Returns:
      metrics config with any overrides applied

    • apply

      default io.helidon.metrics.api.MetricsConfig apply(io.helidon.metrics.api.MetricsConfig metricsConfig)
      Creates a new MetricsConfig instance by applying overrides from this programmatic config instance.
      Parameters:
      metricsConfig - original metrics configuration
      Returns:
      new metrics configuration with overrides applied