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

Class MetricsConfig.BuilderBase.MetricsConfigImpl

java.lang.Object
io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
All Implemented Interfaces:
Prototype.Api, MetricsConfig
Enclosing class:
MetricsConfig.BuilderBase<BUILDER extends MetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsConfig>
protected static class MetricsConfig.BuilderBase.MetricsConfigImpl extends Object implements MetricsConfig
Generated implementation of the prototype, can be extended by descendant prototype implementations.

  • Field Details

    • METRICS_CONFIG_KEY

      static final String METRICS_CONFIG_KEY
      The config key containing settings for all of metrics.
      See Also:

    • SCOPE_CONFIG_KEY

      static final String SCOPE_CONFIG_KEY
      Config key for scope-related settings.
      See Also:

    • KEY_PERFORMANCE_INDICATORS_CONFIG_KEY

      static final String KEY_PERFORMANCE_INDICATORS_CONFIG_KEY
      Config key for KPI metrics settings.
      See Also:

  • Constructor Details

    • MetricsConfigImpl

      protected MetricsConfigImpl(MetricsConfig.BuilderBase<?,?> builder)
      Create an instance providing a builder.
      Parameters:
      builder - extending builder base of this prototype

  • Method Details

    • lookupConfig

      public Optional<String> lookupConfig(String key)
      Description copied from interface: MetricsConfig
      Looks up a single config value within the metrics configuration by config key.
      Specified by:
      lookupConfig in interface MetricsConfig
      Parameters:
      key - config key to fetch
      Returns:
      config value

    • isScopeEnabled

      public boolean isScopeEnabled(String scope)
      Description copied from interface: MetricsConfig
      Reports whether the specified scope is enabled, according to any scope configuration that is part of this metrics configuration.
      Specified by:
      isScopeEnabled in interface MetricsConfig
      Parameters:
      scope - scope name
      Returns:
      true if the scope as a whole is enabled; false otherwise

    • isMeterEnabled

      public boolean isMeterEnabled(String name, String targetScope)
      Description copied from interface: MetricsConfig
      Reports whether the specified meter within the indicated scope is enabled, according to the metrics configuration.
      Specified by:
      isMeterEnabled in interface MetricsConfig
      Parameters:
      name - meter name
      targetScope - scope within which to check
      Returns:
      whether the meter is enabled

    • enabled

      public boolean enabled()

    • permitAll

      public boolean permitAll()

    • roles

      public List<String> roles()

    • keyPerformanceIndicatorMetricsConfig

      public KeyPerformanceIndicatorMetricsConfig keyPerformanceIndicatorMetricsConfig()

    • tags

      public List<Tag> tags()

    • appName

      public Optional<String> appName()

    • appTagName

      public Optional<String> appTagName()

    • scoping

      public ScopingConfig scoping()

    • restRequestEnabled

      public boolean restRequestEnabled()

    • config

      public Config config()

    • gcTimeType

      public GcTimeType gcTimeType()

    • builtInMeterNameFormat

      public BuiltInMeterNameFormat builtInMeterNameFormat()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object