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

Interface MetricsSettings

public interface MetricsSettings
Settings which control behavior for metrics overall.

This class controls all of metrics, not just a single component's usage of metrics. For that, see ComponentMetricsSettings.

  • Method Details

    • create

      static MetricsSettings create()
      Returns default metrics settings based on the metrics section of the default config.
      Returns:
      new settings reflecting the default metrics config

    • create

      static MetricsSettings create(Config config)
      Returns metrics settings based on a Config node, by convention the metrics config section within the overall metrics config.

      Equivalent to MetricsSettings.builder().config(config).build().

      Parameters:
      config - the metrics config section
      Returns:
      new settings reflecting the config, using defaults as needed

    • builder

      static MetricsSettings.Builder builder()
      Returns a builder for MetricsSettings.
      Returns:
      new builder

    • builder

      static MetricsSettings.Builder builder(MetricsSettings metricsSettings)
      Creates a builder based on the values in an existing MetricsSettings instance.
      Parameters:
      metricsSettings - existing instance to copy
      Returns:
      MetricsSettings.Builder initialized according to the provided settings

    • isEnabled

      boolean isEnabled()
      Returns:
      whether metrics are enabled according to the settings

    • keyPerformanceIndicatorSettings

      KeyPerformanceIndicatorMetricsSettings keyPerformanceIndicatorSettings()
      Returns:
      the KPI metrics settings

    • baseMetricsSettings

      BaseMetricsSettings baseMetricsSettings()
      Returns:
      the base metrics settings

    • isMetricEnabled

      boolean isMetricEnabled(MetricRegistry.Type registryType, String metricName)
      Reports whether the specified metric is enabled in the indicated registry type.
      Parameters:
      registryType - which registry type to check
      metricName - name of the metric to check
      Returns:
      true if metrics overall is enabled and if the metric is enabled in the specified registry; false otherwise

    • registrySettings

      RegistrySettings registrySettings(MetricRegistry.Type registryType)
      Returns the RegistrySettings for the indicated registry type.
      Parameters:
      registryType - registry type of interest
      Returns:
      RegistrySettings for the selected type

    • globalTags

      Map<String,String> globalTags()
      Returns the global tags, if any.
      Returns:
      global tag names and values

    • appTagValue

      String appTagValue()
      Returns the app tag value, if any.
      Returns:
      app tag value; null if none set