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

Interface SystemTagsManager

public interface SystemTagsManager
Deals with global and app-level tags to be included in output for all metrics.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    APP_TAG
    MicroProfile-specified tag for app-wide tag.

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterable<Map.Entry<String,String>>
    allTags(Map<String,String> explicitTags)
    Returns a single iterator over the explicit tags in the provided map plus any global and app-level tags.
    Iterable<Map.Entry<String,String>>
    allTags(MetricID metricID)
    Returns a single iterator over the explicit tags in the metric ID plus any global and app-level tags.
    static SystemTagsManager
    create(MetricsSettings metricsSettings)
    Creates a new system tags manager using the provided metrics settings and saves it as the initialized instance returned to subsequent invocations of instance().
    static SystemTagsManager
    instance()
    Returns the initialized instance of the tags manager.

  • Field Details

  • Method Details

    • create

      static SystemTagsManager create(MetricsSettings metricsSettings)
      Creates a new system tags manager using the provided metrics settings and saves it as the initialized instance returned to subsequent invocations of instance().
      Parameters:
      metricsSettings - settings containing the global and app-level tags (if any)
      Returns:
      new tags manager

    • instance

      static SystemTagsManager instance()
      Returns the initialized instance of the tags manager.
      Returns:
      current instance of the tags manager

    • allTags

      Iterable<Map.Entry<String,String>> allTags(MetricID metricID)
      Returns a single iterator over the explicit tags in the metric ID plus any global and app-level tags.
      Parameters:
      metricID - metric ID possibly containing explicit tag settings
      Returns:
      iterator over all tags, explicit and global and app-level

    • allTags

      Iterable<Map.Entry<String,String>> allTags(Map<String,String> explicitTags)
      Returns a single iterator over the explicit tags in the provided map plus any global and app-level tags.
      Parameters:
      explicitTags - map containing explicitly-defined tags for a metric
      Returns:
      iterator over all tags, explicit and global and app-level