Interface MetricCategory

public interface MetricCategory
A MetricCategory is used to group related metrics. Every metric belongs to one and only one MetricCategory.

Categories must be registered with the MetricCategoryRegistry during plugin initialisation.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    getApplicationPrefix()
    Gets the application-specific MetricCategory prefix.
    String
    getName()
    Gets the name of this MetricCategory.

  • Method Details

    • getName

      String getName()
      Gets the name of this MetricCategory.
      Returns:
      The name of this MetricCategory.

    • getApplicationPrefix

      Optional<String> getApplicationPrefix()
      Gets the application-specific MetricCategory prefix. An empty Optional may be returned if this category is not application specific.

      The prefix, if present, is prepended to the category name when creating a single combined name for metrics.

      Returns:
      An optional application prefix.