Package de.iip_ecosphere.platform.support.metrics

Interface Meter

All Known Subinterfaces:
Counter, Gauge, Timer
public interface Meter
Something that meters something.
Author:
Holger Eichelberger, SSE

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Meter.Id
    A Meter id.
    static enum 
    Meter.Type
    Custom meters may emit metrics like one of these types without implementing the corresponding interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    Meter.Id
    getId()
    Returns the id.
    String
    getName()
    Returns the name of the meter.
    Iterable<Measurement>
    measure()
    Get a set of measurements.

  • Method Details

    • getName

      String getName()
      Returns the name of the meter. May be ambiougous if multiple meters exist with different tags. Then the returned name may refer to all.
      Returns:
      the name

    • getId

      Meter.Id getId()
      Returns the id.
      Returns:
      the id

    • measure

      Iterable<Measurement> measure()
      Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.
      Returns:
      The set of measurements that represents the instantaneous value of this meter.