Package org.terracotta.statistics.derived.latency

Class DefaultLatencyHistogramStatistic

java.lang.Object

org.terracotta.statistics.derived.latency.DefaultLatencyHistogramStatistic

All Implemented Interfaces:

LatencyHistogramQuery, LatencyHistogramStatistic, ChainedEventObserver, ChainedObserver

public class DefaultLatencyHistogramStatistic
extends Object
implements LatencyHistogramStatistic, ChainedEventObserver

Author:

Mathieu Carbou

Constructor Summary

Constructors

Constructor	Description
DefaultLatencyHistogramStatistic(double phi, int bucketCount, Duration window)
DefaultLatencyHistogramStatistic(double phi, int bucketCount, Duration window, LongSupplier timeSupplier)	Create a histogram maintained over a sliding time window.

Method Summary

Modifier and Type	Method	Description
List<Histogram.Bucket>	buckets()
long	count()
void	event(long time, long latency)	Called to indicate an event happened.
Long	maximum()
Long	minimum()
Long	percentile(double percent)
long[]	percentileBounds(double percent)
<T> T	query(Function<LatencyHistogramQuery,T> fn)	Enables to query the histogram several times within a synchronized state so that every calls are consistent
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.terracotta.statistics.derived.latency.LatencyHistogramQuery

median

Methods inherited from interface org.terracotta.statistics.derived.latency.LatencyHistogramStatistic

maximumStatistic, medianStatistic, minimumStatistic, percentileStatistic

Constructor Detail

DefaultLatencyHistogramStatistic

public DefaultLatencyHistogramStatistic(double phi,
                                        int bucketCount,
                                        Duration window,
                                        LongSupplier timeSupplier)

Create a histogram maintained over a sliding time window.

The constructed histogram is:

• maintained over window sliding window
• consists of bucketCount buckets
• where b1.size() ~= b0.size * phi

If "phi" is high, the quantile bounds will be more precise for lower percentiles such as minimum. If "phi" is low, the quantile bounds will be more precise for higher percentiles such as 99%-ile, maximum.

Parameters:

phi - histogram bucket bias factor

bucketCount - number of buckets

window - sliding window size, in ns

timeSupplier - the supplier of time, which must be in the same unit as the time passed to the {event(long, long)} method.

DefaultLatencyHistogramStatistic

public DefaultLatencyHistogramStatistic(double phi,
                                        int bucketCount,
                                        Duration window)

Method Detail

buckets

public List<Histogram.Bucket> buckets()

Specified by:

buckets in interface LatencyHistogramQuery

count

public long count()

Specified by:

count in interface LatencyHistogramQuery

minimum

public Long minimum()

Specified by:

minimum in interface LatencyHistogramQuery

Returns:

The minimum value or null if no value

maximum

public Long maximum()

Specified by:

maximum in interface LatencyHistogramQuery

Returns:

The maximum value or null if no value

percentile

public Long percentile(double percent)

Specified by:

percentile in interface LatencyHistogramQuery

Parameters:

percent - the percentage (0.0-1.0)

Returns:

the value below which percent% of the observations may be found. Will return the upper bound of the approximated range.

percentileBounds

public long[] percentileBounds(double percent)

Specified by:

percentileBounds in interface LatencyHistogramQuery

Parameters:

percent - the percentage (0.0-1.0)

Returns:

the inclusive bounds (min and max) representing the range containing the right value for the given percent%-ile.

event

public void event(long time,
                  long latency)

Description copied from interface: ChainedEventObserver

Called to indicate an event happened.

Specified by:

event in interface ChainedEventObserver

Parameters:

time - the clock at event completion in ns

latency - the event latency in ns

query

public <T> T query(Function<LatencyHistogramQuery,T> fn)

Description copied from interface: LatencyHistogramStatistic

Enables to query the histogram several times within a synchronized state so that every calls are consistent

Specified by:

query in interface LatencyHistogramStatistic

toString

public String toString()

Overrides:

toString in class Object