org.javasimon.callback.quantiles

Class AutoQuantilesCallback

java.lang.Object

org.javasimon.callback.CallbackSkeleton

org.javasimon.callback.quantiles.QuantilesCallback

org.javasimon.callback.quantiles.AutoQuantilesCallback

All Implemented Interfaces:

Callback

public class AutoQuantilesCallback
extends QuantilesCallback

Callback which stores data in buckets to compute quantiles. Quantiles can only be obtained after warmup period, after which buckets are initialized. For each Simon the following lifecycle occurs:

1. Warm up:
   • Buckets do not exist
   • Quantiles can not be computed
   • Splits are kept
2. Trigger: splits count >= warmup count threshold
   • Buckets are created, configuration (min, max) is determined from kept splits, bucket number is constant
   • Buckets are filled with previously stored splits
   • Retained splits are removed
   • From now on, quantiles can not be computed and splits are not kept anymore
3. Normal:
   • Buckets are filled/updated with new splits as they come
   • Quantiles can be computed (provided there is enough splits and buckets are properly configured)

Since:

3.2

Author:

gquintana

See Also:

Buckets

Nested Class Summary

Nested classes/interfaces inherited from interface org.javasimon.callback.Callback

Callback.Event

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_NAME_BUCKETS_VALUES Simon attribute name of the list of split values stored in Simons before warmup time.

Fields inherited from class org.javasimon.callback.quantiles.QuantilesCallback

ATTR_NAME_BUCKETS

Constructor Summary

Constructors

Constructor and Description
AutoQuantilesCallback() Default constructor.
AutoQuantilesCallback(BucketsType bucketsType, long warmupCounter, int bucketNb) Constructor with all configuration.
AutoQuantilesCallback(long warmupCounter, int bucketNb) Constructor with warmup counter and number of linear buckets for each Simon.

Method Summary

Methods

Modifier and Type	Method and Description
protected Buckets	createBuckets(Stopwatch stopwatch) When warmup ends, buckets are create and retained splits are sorted in the buckets.
protected Buckets	createBucketsAfterWarmup(Stopwatch stopwatch) Create the buckets after warmup time.
void	onSimonCreated(Simon simon) When simon is created, the list containing Split values is added to stopwatch attributes.
protected void	onStopwatchSplit(Stopwatch stopwatch, Split split) Called when there is a new split on a Stopwatch, either QuantilesCallback.onStopwatchStop(org.javasimon.Split, org.javasimon.StopwatchSample) or QuantilesCallback.onStopwatchAdd(org.javasimon.Stopwatch, org.javasimon.Split, org.javasimon.StopwatchSample).

Methods inherited from class org.javasimon.callback.quantiles.QuantilesCallback

createBuckets, createLogTemplate, getBuckets, getBucketsType, getOrCreateBuckets, isLogEnabled, onStopwatchAdd, onStopwatchStop, sampleBuckets, setLogEnabled

Methods inherited from class org.javasimon.callback.CallbackSkeleton

cleanup, initialize, onCounterDecrease, onCounterIncrease, onCounterSet, onManagerClear, onManagerMessage, onManagerWarning, onSimonDestroyed, onStopwatchStart

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_BUCKETS_VALUES

public static final String ATTR_NAME_BUCKETS_VALUES

Simon attribute name of the list of split values stored in Simons before warmup time.

See Also:

Constant Field Values

Constructor Detail

AutoQuantilesCallback

public AutoQuantilesCallback()

Default constructor.

AutoQuantilesCallback

public AutoQuantilesCallback(long warmupCounter,
                     int bucketNb)

Constructor with warmup counter and number of linear buckets for each Simon.

AutoQuantilesCallback

public AutoQuantilesCallback(BucketsType bucketsType,
                     long warmupCounter,
                     int bucketNb)

Constructor with all configuration.

Parameters:

bucketsType - Linear or exponential

warmupCounter - Number of splits before init

bucketNb - Bucket number

Method Detail

createBucketsAfterWarmup

protected Buckets createBucketsAfterWarmup(Stopwatch stopwatch)

Create the buckets after warmup time. Can be overridden to customize buckets configuration. By default buckets are create with:

• Min: stopwatch min-10% rounded to inferior millisecond
• Max: stopwatch max+10 rounded to superior millisecond
• Nb buckets: bucketNb

Parameters:

stopwatch - Stopwatch (containing configuration)

Returns:

new Buckets objects

createBuckets

protected final Buckets createBuckets(Stopwatch stopwatch)

When warmup ends, buckets are create and retained splits are sorted in the buckets.

Specified by:

createBuckets in class QuantilesCallback

Parameters:

stopwatch - Stopwatch

Returns:

Buckets

onSimonCreated

public void onSimonCreated(Simon simon)

When simon is created, the list containing Split values is added to stopwatch attributes.

Specified by:

onSimonCreated in interface Callback

Overrides:

onSimonCreated in class CallbackSkeleton

Parameters:

simon - created Simon

onStopwatchSplit

protected void onStopwatchSplit(Stopwatch stopwatch,
                    Split split)

Called when there is a new split on a Stopwatch, either QuantilesCallback.onStopwatchStop(org.javasimon.Split, org.javasimon.StopwatchSample) or QuantilesCallback.onStopwatchAdd(org.javasimon.Stopwatch, org.javasimon.Split, org.javasimon.StopwatchSample). If buckets have been initialized, the value is added to appropriate bucket. Else if stopwatch is warming up value is added to value list.

Overrides:

onStopwatchSplit in class QuantilesCallback