com.netflix.spectator.api

Interface DistributionSummary

All Superinterfaces:

Meter

All Known Implementing Classes:

BucketCounter, BucketDistributionSummary, PercentileDistributionSummary

public interface DistributionSummary
extends Meter

Track the sample distribution of events. An example would be the response sizes for requests hitting and http server. The precise set of information maintained depends on the implementation. Most should try to provide a consistent implementation of count() and totalAmount(), but some implementations may not. In particular, the implementation from NoopRegistry will always return 0.

Method Summary

Modifier and Type	Method and Description
long	count() The number of times that record has been called since this timer was created.
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 created.

Methods inherited from interface com.netflix.spectator.api.Meter

hasExpired, id, measure

Method Detail

record

void record(long amount)

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

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.

count

long count()

The number of times that record has been called since this timer was created.

totalAmount

long totalAmount()

The total amount of all recorded events since this summary was created.