org.ballerinalang.util.metrics.noop

Class NoOpTimer

java.lang.Object

org.ballerinalang.util.metrics.AbstractMetric

org.ballerinalang.util.metrics.noop.NoOpTimer

All Implemented Interfaces:

Metric, Timer

public class NoOpTimer
extends AbstractMetric
implements Timer

Implementation of No-Op Timer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ballerinalang.util.metrics.Timer

Timer.Builder

Constructor Summary

Constructors

Constructor and Description
NoOpTimer(MetricId id)

Method Summary

Modifier and Type	Method and Description
long	count()
double	max(TimeUnit unit)
double	mean(TimeUnit unit)
double	percentile(double percentile, TimeUnit unit)
void	record(long amount, TimeUnit unit) Updates the statistics kept by the timer with the specified amount.

Methods inherited from class org.ballerinalang.util.metrics.AbstractMetric

equals, getId, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ballerinalang.util.metrics.Timer

builder, record

Methods inherited from interface org.ballerinalang.util.metrics.Metric

getId

Constructor Detail

NoOpTimer

public NoOpTimer(MetricId id)

Method Detail

record

public void record(long amount,
                   TimeUnit unit)

Description copied from interface: Timer

Updates the statistics kept by the timer with the specified amount.

Specified by:

record in interface Timer

Parameters:

amount - Duration of a single event being measured by this timer.

unit - Time unit for the amount being recorded.

count

public long count()

Specified by:

count in interface Timer

Returns:

The number of times that record has been called since this timer was created.

mean

public double mean(TimeUnit unit)

Specified by:

mean in interface Timer

Parameters:

unit - The base unit of time to scale the mean to.

Returns:

The distribution average for all recorded events.

max

public double max(TimeUnit unit)

Specified by:

max in interface Timer

Parameters:

unit - The base unit of time to scale the max to.

Returns:

The maximum time of a single event.

percentile

public double percentile(double percentile,
                         TimeUnit unit)

Specified by:

percentile in interface Timer

Parameters:

percentile - A percentile in the domain [0, 1]. For example, 0.5 represents the 50th percentile of the distribution.

unit - The base unit of time to scale the percentile value to.

Returns:

The latency at a specific percentile. This value is non-aggregable across dimensions.