Package com.inductiveautomation.ignition.gateway.metrics

Class DescriptiveTimer

  • All Implemented Interfaces:
    com.codahale.metrics.Counting, com.codahale.metrics.Metered, com.codahale.metrics.Metric, com.codahale.metrics.Sampling, DescriptiveMetric
    public class DescriptiveTimer
extends com.codahale.metrics.Timer
implements DescriptiveMetric

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.codahale.metrics.Timer

        com.codahale.metrics.Timer.Context

    • Constructor Summary

      Constructors 
      Constructor Description
      DescriptiveTimer​(java.util.function.Function<java.util.Locale,​java.lang.String> description, java.util.function.Function<java.util.Locale,​java.lang.String> units)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription​(java.util.Locale locale)
      A short description of what this metric represents.
      java.lang.String getUnits​(java.util.Locale locale)
      A short string representing the units of this metric.

      • Methods inherited from class com.codahale.metrics.Timer

        getCount, getFifteenMinuteRate, getFiveMinuteRate, getMeanRate, getOneMinuteRate, getSnapshot, time, time, time, timeSupplier, update, update

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DescriptiveTimer

        public DescriptiveTimer​(java.util.function.Function<java.util.Locale,​java.lang.String> description,
                        java.util.function.Function<java.util.Locale,​java.lang.String> units)

    • Method Detail

      • getDescription

        public java.lang.String getDescription​(java.util.Locale locale)
        Description copied from interface: DescriptiveMetric
        A short description of what this metric represents. For example "JVM Heap Size" or "Thread Count" or "Subsystem X script executions"
        Specified by:
        getDescription in interface DescriptiveMetric

      • getUnits

        public java.lang.String getUnits​(java.util.Locale locale)
        Description copied from interface: DescriptiveMetric
        A short string representing the units of this metric. For example "MB" or "threads" or "executions"
        Specified by:
        getUnits in interface DescriptiveMetric