com.netflix.spectator.api.histogram

Class PercentileDistributionSummary

java.lang.Object

com.netflix.spectator.api.histogram.PercentileDistributionSummary

All Implemented Interfaces:

DistributionSummary, Meter

public class PercentileDistributionSummary
extends java.lang.Object
implements DistributionSummary

Distribution summary that buckets the counts to allow for estimating percentiles.

Method Summary

Modifier and Type	Method and Description
long	count() The number of times that record has been called since this timer was last reset.
static PercentileDistributionSummary	get(Registry registry, Id id) Creates a distribution summary object that can be used for estimating percentiles.
boolean	hasExpired() Indicates whether the meter is expired.
Id	id() Identifier used to lookup this meter in the registry.
java.lang.Iterable<Measurement>	measure() Get the set of measurements for this meter.
double	percentile(double p) Computes the specified percentile for this distribution summary.
void	record(long amount) Updates the statistics kept by the summary with the specified amount.
long	totalAmount() The total amount of all recorded events since this summary was last reset.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static PercentileDistributionSummary get(Registry registry,
                                                Id id)

Creates a distribution summary object that can be used for estimating percentiles.

Parameters:

registry - Registry to use.

id - Identifier for the metric being registered.

Returns:

Distribution summary that keeps track of counts by buckets that can be used to estimate the percentiles for the distribution.

id

public Id id()

Description copied from interface: Meter

Identifier used to lookup this meter in the registry.

Specified by:

id in interface Meter

measure

public java.lang.Iterable<Measurement> measure()

Description copied from interface: Meter

Get the set of measurements for this meter.

Specified by:

measure in interface Meter

hasExpired

public boolean hasExpired()

Description copied from interface: Meter

Indicates whether the meter is expired. For example, a counter might expire if there is no activity within a given time frame.

Specified by:

hasExpired in interface Meter

record

public void record(long amount)

Description copied from interface: DistributionSummary

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

Specified by:

record in interface DistributionSummary

Parameters:

amount - Amount for an event being measured. For example, if the size in bytes of responses from a server. If the amount is less than 0 the value will be dropped.

percentile

public double percentile(double p)

Computes the specified percentile for this distribution summary.

Parameters:

p - Percentile to compute, value must be 0.0 <= p <= 100.0.

Returns:

An approximation of the p`th percentile in seconds.

count

public long count()

Description copied from interface: DistributionSummary

The number of times that record has been called since this timer was last reset. How often a timer is reset depends on the underlying registry implementation.

Specified by:

count in interface DistributionSummary

totalAmount

public long totalAmount()

Description copied from interface: DistributionSummary

The total amount of all recorded events since this summary was last reset. How often a timer is reset depends on the underlying registry implementation.

Specified by:

totalAmount in interface DistributionSummary