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

Interface KeyPerformanceIndicatorMetricsSettings

All Known Subinterfaces:
KeyPerformanceIndicatorMetricsSettings
public interface KeyPerformanceIndicatorMetricsSettings
Settings for key performance indicator (KPI) metrics.

The Helidon SE and MP metrics guides describe the KPI metrics and how to control them using config and this settings interface.

  • Method Details

    • create

      static KeyPerformanceIndicatorMetricsSettings create(Config kpiConfig)
      Creates a new KeyPerformanceIndicatorMetricsSettings instance from the specified config node containing KPI metrics settings.
      Parameters:
      kpiConfig - config node containing KPI metrics settings
      Returns:
      new KPI metrics settings reflecting the config

    • builder

      static KeyPerformanceIndicatorMetricsSettings.Builder builder()
      Creates a new builder for the settings.
      Returns:
      new KeyPerformanceIndicatorMetricsSettings.Builder

    • builder

      static KeyPerformanceIndicatorMetricsSettings.Builder builder(KeyPerformanceIndicatorMetricsSettings kpiMetricsSettings)
      Creates a builder using the values from an existing KeyPerformanceIndicatorMetricsSettings instance.
      Parameters:
      kpiMetricsSettings - existing KPI metrics settings to copy
      Returns:
      new Builder initialized according to the provide settings

    • isExtended

      boolean isExtended()
      Returns:
      whether extended KPI metrics are enabled in the settings

    • longRunningRequestThresholdMs

      long longRunningRequestThresholdMs()
      Returns:
      the threshold (in ms) for long-running requests