Package com.inductiveautomation.ignition.gateway.metrics

Interface DescriptiveMetric

All Known Implementing Classes:
DescriptiveCounter, DescriptiveGauge, DescriptiveHistogram, DescriptiveMeter, DescriptiveRatioGauge, DescriptiveTimer
public interface DescriptiveMetric
An interface for Metrics that know how to describe themselves and their units.

  • Method Details

    • getDescription

      default String getDescription()

    • getDescription

      String getDescription(Locale locale)
      A short description of what this metric represents. For example "JVM Heap Size" or "Thread Count" or "Subsystem X script executions"

    • getUnits

      default String getUnits()

    • getUnits

      String getUnits(Locale locale)
      A short string representing the units of this metric. For example "MB" or "threads" or "executions"