Package com.inductiveautomation.ignition.gateway.metrics

Class MetricBuilder

java.lang.Object
com.inductiveautomation.ignition.gateway.metrics.MetricBuilder
public class MetricBuilder extends Object
This builder helps build metrics that implement DescriptiveMetric.

  • Constructor Details

    • MetricBuilder

      public MetricBuilder()

  • Method Details

    • newBuilder

      public static MetricBuilder newBuilder()

    • registry

      public MetricBuilder registry(com.codahale.metrics.MetricRegistry registry)

    • name

      public MetricBuilder name(String name)

    • name

      public MetricBuilder name(String category, String... names)

    • description

      public MetricBuilder description(String description)

    • descriptionKey

      public MetricBuilder descriptionKey(String key)

    • units

      public MetricBuilder units(String units)

    • unitsKey

      public MetricBuilder unitsKey(String key)

    • buildGauge

      public <T> com.codahale.metrics.Gauge<T> buildGauge(com.codahale.metrics.Gauge<T> gauge)

    • getOrAddGauge

      public <T> com.codahale.metrics.Gauge<T> getOrAddGauge(com.codahale.metrics.Gauge<T> gauge)

    • buildCounter

      public com.codahale.metrics.Counter buildCounter()

    • getOrAddCounter

      public com.codahale.metrics.Counter getOrAddCounter()

    • buildHistogram

      public com.codahale.metrics.Histogram buildHistogram()

    • getOrAddHistogram

      public com.codahale.metrics.Histogram getOrAddHistogram()

    • buildRatioGauge

      public com.codahale.metrics.Gauge<Double> buildRatioGauge(Supplier<Double> numerator, Supplier<Double> denominator)

    • getOrAddRatioGauge

      public com.codahale.metrics.Gauge<Double> getOrAddRatioGauge(Supplier<Double> numerator, Supplier<Double> denominator)

    • buildTimer

      public com.codahale.metrics.Timer buildTimer()

    • getOrAddTimer

      public com.codahale.metrics.Timer getOrAddTimer()

    • addDelegateTimer

      public com.codahale.metrics.Timer addDelegateTimer(com.codahale.metrics.Timer delegate)
      Wraps the given timer in a descriptive delegate, and adds it to the registry.

    • buildDelegateTimer

      public com.codahale.metrics.Timer buildDelegateTimer(com.codahale.metrics.Timer delegate)
      Builds a timer that delegates to the given timer, but adds description and units.

    • buildMeter

      public com.codahale.metrics.Meter buildMeter()
      Builds a meter with the given description and units, or a plain meter if they have not been specified. Does not add the meter to the registry.

    • getOrAddMeter

      public com.codahale.metrics.Meter getOrAddMeter()

    • addDelegateMeter

      public com.codahale.metrics.Meter addDelegateMeter(com.codahale.metrics.Meter delegate)
      Wraps the given meter in a descriptive delegate, and adds it to the registry.

    • buildDelegateMeter

      public com.codahale.metrics.Meter buildDelegateMeter(com.codahale.metrics.Meter delegate)
      Builds a meter that delegates to the given meter, but adds description and units.