com.netflix.spectator.api.histogram

Class PercentileTimer.Builder

java.lang.Object

com.netflix.spectator.api.patterns.TagsBuilder<PercentileTimer.Builder>

com.netflix.spectator.api.histogram.PercentileTimer.Builder

Enclosing class:

PercentileTimer

public static final class PercentileTimer.Builder
extends TagsBuilder<PercentileTimer.Builder>

Helper for getting instances of a PercentileTimer.

Field Summary

Fields inherited from class com.netflix.spectator.api.patterns.TagsBuilder

extraTags

Method Summary

Modifier and Type	Method and Description
PercentileTimer	build() Create or get an instance of the percentile timer with the specified settings.
PercentileTimer.Builder	withRange(Duration min, Duration max) Sets the threshold for this timer.
PercentileTimer.Builder	withRange(long min, long max, TimeUnit unit) Sets the range for this timer.

Methods inherited from class com.netflix.spectator.api.patterns.TagsBuilder

withTag, withTag, withTag, withTag, withTags, withTags, withTags, withTags

Methods inherited from class java.lang.Object

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

Method Detail

withRange

public PercentileTimer.Builder withRange(Duration min,
                                         Duration max)

Sets the threshold for this timer. For more information see withRange(long, long, TimeUnit).

Parameters:

min - Duration indicating the minimum value for this timer.

max - Duration indicating the maximum value for this timer.

Returns:

This builder instance to allow chaining of operations.

withRange

public PercentileTimer.Builder withRange(long min,
                                         long max,
                                         TimeUnit unit)

Sets the range for this timer. The range should be the SLA boundary or failure point for the activity. Explicitly setting the range allows us to optimize for the important range of values and reduce the overhead associated with tracking the data distribution. For example, suppose you are making a client call and timeout after 10 seconds. Setting the range to 10 seconds will restrict the possible set of buckets used to those approaching the boundary. So we can still detect if it is nearing failure, but percentiles that are further away from the range may be inflated compared to the actual value.

Parameters:

min - Amount indicating the minimum allowed value for this timer.

max - Amount indicating the maximum allowed value for this timer.

unit - Unit for the specified amount.

Returns:

This builder instance to allow chaining of operations.

build

public PercentileTimer build()

Create or get an instance of the percentile timer with the specified settings.