Package com.inductiveautomation.ignition.gateway.metrics

Class MetricBuilder

java.lang.Object

com.inductiveautomation.ignition.gateway.metrics.MetricBuilder

public class MetricBuilder
extends java.lang.Object

This builder helps build metrics that implement DescriptiveMetric.

Constructor Summary

Constructors

Constructor	Description
MetricBuilder()

Method Summary

Modifier and Type	Method	Description
com.codahale.metrics.Counter	buildCounter()
<T> com.codahale.metrics.Gauge<T>	buildGauge(com.codahale.metrics.Gauge<T> gauge)
com.codahale.metrics.Histogram	buildHistogram()
com.codahale.metrics.Meter	buildMeter()
com.codahale.metrics.Gauge<java.lang.Double>	buildRatioGauge(java.util.function.Supplier<java.lang.Double> numerator, java.util.function.Supplier<java.lang.Double> denominator)
com.codahale.metrics.Timer	buildTimer()
MetricBuilder	description(java.lang.String description)
MetricBuilder	descriptionKey(java.lang.String key)
com.codahale.metrics.Counter	getOrAddCounter()
<T> com.codahale.metrics.Gauge<T>	getOrAddGauge(com.codahale.metrics.Gauge<T> gauge)
com.codahale.metrics.Histogram	getOrAddHistogram()
com.codahale.metrics.Meter	getOrAddMeter()
com.codahale.metrics.Gauge<java.lang.Double>	getOrAddRatioGauge(java.util.function.Supplier<java.lang.Double> numerator, java.util.function.Supplier<java.lang.Double> denominator)
com.codahale.metrics.Timer	getOrAddTimer()
MetricBuilder	name(java.lang.String name)
MetricBuilder	name(java.lang.String category, java.lang.String... names)
static MetricBuilder	newBuilder()
MetricBuilder	registry(com.codahale.metrics.MetricRegistry registry)
MetricBuilder	units(java.lang.String units)
MetricBuilder	unitsKey(java.lang.String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricBuilder

public MetricBuilder()

Method Detail

newBuilder

public static MetricBuilder newBuilder()

registry

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

name

public MetricBuilder name(java.lang.String name)

name

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

description

public MetricBuilder description(java.lang.String description)

descriptionKey

public MetricBuilder descriptionKey(java.lang.String key)

units

public MetricBuilder units(java.lang.String units)

unitsKey

public MetricBuilder unitsKey(java.lang.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<java.lang.Double> buildRatioGauge(java.util.function.Supplier<java.lang.Double> numerator,
                                                                    java.util.function.Supplier<java.lang.Double> denominator)

getOrAddRatioGauge

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

buildTimer

public com.codahale.metrics.Timer buildTimer()

getOrAddTimer

public com.codahale.metrics.Timer getOrAddTimer()

buildMeter

public com.codahale.metrics.Meter buildMeter()

getOrAddMeter

public com.codahale.metrics.Meter getOrAddMeter()