Package de.iip_ecosphere.platform.support.metrics

Interface Meter.Id

Enclosing interface:
Meter
public static interface Meter.Id
A Meter id.
Author:
Holger Eichelberger, SSE

  • Method Details

    • getName

      String getName()
      Returns the name.
      Returns:
      the name of this meter.

    • getTags

      List<Tag> getTags()
      Returns the tags.
      Returns:
      a set of dimensions that allows you to break down the name.

    • getTagsAsIterable

      Iterable<Tag> getTagsAsIterable()
      Returns the tags.
      Returns:
      a set of dimensions that allows you to break down the name.

    • getTag

      String getTag(String key)
      Returns a specific tag value.
      Parameters:
      key - The tag key to attempt to match
      Returns:
      A matching tag value, or null if no tag with the provided key exists on this id.

    • getBaseUnit

      String getBaseUnit()
      Returns the base unit.
      Returns:
      The base unit of measurement for this meter, may be null

    • getDescription

      String getDescription()
      Returns the description.
      Returns:
      A description of the meter's purpose. This description text is published to monitoring systems that support description text.

    • getType

      Meter.Type getType()
      The type is used by different registry implementations to structure the exposition of metrics to different backends.
      Returns:
      The meter's type.