Package com.inductiveautomation.ignition.gateway.metrics

Class DescriptiveDelegateTimer

java.lang.Object

com.codahale.metrics.Timer

com.inductiveautomation.ignition.gateway.metrics.DescriptiveDelegateTimer

All Implemented Interfaces:

com.codahale.metrics.Counting, com.codahale.metrics.Metered, com.codahale.metrics.Metric, com.codahale.metrics.Sampling, DescriptiveMetric

public class DescriptiveDelegateTimer
extends com.codahale.metrics.Timer
implements DescriptiveMetric

A timer implementation that delegates to another Timer instance, while adding descriptive attributes.

Nested Class Summary

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

com.codahale.metrics.Timer.Context

Constructor Summary

Constructors

Constructor	Description
DescriptiveDelegateTimer(com.codahale.metrics.Timer delegate, Function<Locale,String> description, Function<Locale,String> units)

Method Summary

Modifier and Type	Method	Description
long	getCount()
String	getDescription(Locale locale)	A short description of what this metric represents.
double	getFifteenMinuteRate()
double	getFiveMinuteRate()
double	getMeanRate()
double	getOneMinuteRate()
com.codahale.metrics.Snapshot	getSnapshot()
String	getUnits(Locale locale)	A short string representing the units of this metric.
com.codahale.metrics.Timer.Context	time()
void	time(Runnable event)
<T> T	time(Callable<T> event)
<T> T	timeSupplier(Supplier<T> event)
void	update(long duration, TimeUnit unit)
void	update(Duration duration)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.metrics.DescriptiveMetric

getDescription, getUnits

Constructor Details

DescriptiveDelegateTimer

public DescriptiveDelegateTimer(com.codahale.metrics.Timer delegate,
 Function<Locale,String> description,
 Function<Locale,String> units)

Method Details

getDescription

public String getDescription(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 String getUnits(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

update

public void update(long duration,
 TimeUnit unit)

Overrides:

update in class com.codahale.metrics.Timer

update

public void update(Duration duration)

Overrides:

update in class com.codahale.metrics.Timer

time

public <T> T time(Callable<T> event)
           throws Exception

Overrides:

time in class com.codahale.metrics.Timer

Throws:

Exception

timeSupplier

public <T> T timeSupplier(Supplier<T> event)

Overrides:

timeSupplier in class com.codahale.metrics.Timer

time

public void time(Runnable event)

Overrides:

time in class com.codahale.metrics.Timer

time

public com.codahale.metrics.Timer.Context time()

Overrides:

time in class com.codahale.metrics.Timer

getCount

public long getCount()

Specified by:

getCount in interface com.codahale.metrics.Counting

Specified by:

getCount in interface com.codahale.metrics.Metered

Overrides:

getCount in class com.codahale.metrics.Timer

getFifteenMinuteRate

public double getFifteenMinuteRate()

Specified by:

getFifteenMinuteRate in interface com.codahale.metrics.Metered

Overrides:

getFifteenMinuteRate in class com.codahale.metrics.Timer

getFiveMinuteRate

public double getFiveMinuteRate()

Specified by:

getFiveMinuteRate in interface com.codahale.metrics.Metered

Overrides:

getFiveMinuteRate in class com.codahale.metrics.Timer

getMeanRate

public double getMeanRate()

Specified by:

getMeanRate in interface com.codahale.metrics.Metered

Overrides:

getMeanRate in class com.codahale.metrics.Timer

getOneMinuteRate

public double getOneMinuteRate()

Specified by:

getOneMinuteRate in interface com.codahale.metrics.Metered

Overrides:

getOneMinuteRate in class com.codahale.metrics.Timer

getSnapshot

public com.codahale.metrics.Snapshot getSnapshot()

Specified by:

getSnapshot in interface com.codahale.metrics.Sampling

Overrides:

getSnapshot in class com.codahale.metrics.Timer