com.netflix.spectator.api.histogram

Class PercentileDistributionSummary.Builder

java.lang.Object

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

com.netflix.spectator.api.histogram.PercentileDistributionSummary.Builder

Enclosing class:

PercentileDistributionSummary

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

Helper for getting instances of a PercentileDistributionSummary.

Field Summary

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

extraTags

Method Summary

Modifier and Type	Method and Description
PercentileDistributionSummary	build() Create or get an instance of the percentile distribution summary with the specified settings.
PercentileDistributionSummary.Builder	withRange(long min, long max) Sets the range for this summary.

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 PercentileDistributionSummary.Builder withRange(long min,
                                                       long max)

Sets the range for this summary. The range is should be the SLA boundary or failure point for the activity. Explicitly setting the threshold 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 the max payload size is 8mb. Setting the threshold to 8mb 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 summary.

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

Returns:

This builder instance to allow chaining of operations.

build

public PercentileDistributionSummary build()

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