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

Interface MetricsSettings.Builder

All Superinterfaces:
Builder<MetricsSettings.Builder,MetricsSettings>, Supplier<MetricsSettings>
Enclosing interface:
MetricsSettings
public static interface MetricsSettings.Builder extends Builder<MetricsSettings.Builder,MetricsSettings>
Builder for MetricsSettings.

  • Field Details

    • ENABLED_CONFIG_KEY

      static final String ENABLED_CONFIG_KEY
      Config key within the config metrics section controlling whether metrics are enabled.
      See Also:

    • METRICS_CONFIG_KEY

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

    • BASE_CONFIG_KEY

      static final String BASE_CONFIG_KEY
      Config key within the config metrics section controlling the base registry.
      See Also:

    • REGISTRIES_CONFIG_KEY

      static final String REGISTRIES_CONFIG_KEY
      Config key within the config metrics section containing settings for individual registries.
      See Also:

    • DEFAULT_CONTEXT

      static final String DEFAULT_CONTEXT
      Default web context for the metrics endpoint.
      See Also:

    • EXEMPLARS_STRICT_CONFIG_KEY

      static final String EXEMPLARS_STRICT_CONFIG_KEY
      Config key within metrics for strict (vs. lax) exemplar behavior.
      See Also:

    • GLOBAL_TAGS_CONFIG_KEY

      static final String GLOBAL_TAGS_CONFIG_KEY
      Config key for comma-separated, tag=value global tag settings.
      See Also:

    • APP_TAG_CONFIG_KEY

      static final String APP_TAG_CONFIG_KEY
      Config key for the app tag value to be applied to all metrics in this application.
      See Also:

  • Method Details

    • build

      MetricsSettings build()
      Constructs a MetricsSettings object from the builder.
      Specified by:
      build in interface Builder<MetricsSettings.Builder,MetricsSettings>
      Returns:
      new settings instance based on the builder

    • enabled

      MetricsSettings.Builder enabled(boolean value)
      Sets whether metrics should be enabled.
      Parameters:
      value - true if metrics should be enabled; false if not
      Returns:
      updated builder

    • config

      MetricsSettings.Builder config(Config config)
      Updates the builder using the provided metrics config.
      Parameters:
      config - the component's or the overall metrics config from the configuration
      Returns:
      updated builder

    • keyPerformanceIndicatorSettings

      MetricsSettings.Builder keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder kpiSettings)
      Set the KPI metrics settings.
      Parameters:
      kpiSettings - key performance indicator metrics settings to use
      Returns:
      updated builder

    • baseMetricsSettings

      MetricsSettings.Builder baseMetricsSettings(BaseMetricsSettings.Builder baseMetricsSettingsBuilder)
      Set the base metrics settings.
      Parameters:
      baseMetricsSettingsBuilder - base metrics settings to use
      Returns:
      updated builder

    • registrySettings

      MetricsSettings.Builder registrySettings(MetricRegistry.Type registryType, RegistrySettings registrySettings)
      Sets the registry settings for the specified registry type.
      Parameters:
      registryType - type of registry for which to assign settings
      registrySettings - assigned registry settings
      Returns:
      updated builder

    • globalTags

      MetricsSettings.Builder globalTags(Map<String,String> globalTags)
      Sets the global tags to be applied to all metrics.
      Parameters:
      globalTags - map of tag name/tag value pairs
      Returns:
      updatedbuilder

    • appTagValue

      MetricsSettings.Builder appTagValue(String appTag)
      Sets the value for the _app tag to be applied to all metrics.
      Parameters:
      appTag - app tag value
      Returns:
      updated builder