org.forgerock.monitoring.api.instrument

Interface DistributionSummary

All Superinterfaces:

Meter

All Known Implementing Classes:

DropwizardTypes.DescribableMeter

public interface DistributionSummary
extends Meter

Track the sample distribution of events. An example would be the response sizes for requests hitting and http server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DistributionSummary.Builder Fluent builder for distribution summaries.

Nested classes/interfaces inherited from interface org.forgerock.monitoring.api.instrument.Meter

Meter.Id, Meter.Type

Method Summary

Modifier and Type	Method and Description
static DistributionSummary.Builder	builder(String name)
long	count() The number of times that record has been called since this timer was created.
double	histogramCountAtValue(long value)
double	max() The maximum time of a single event.
default double	mean()
default Iterable<Measurement>	measure() Get a set of measurements.
double	percentile(double percentile) The value at a specific percentile.
default void	record() Updates the statistics kept by the summary.
void	record(double amount) Updates the statistics kept by the summary with the specified amount.
HistogramSnapshot	takeSnapshot(boolean supportsAggregablePercentiles)
double	totalAmount() The total amount of all recorded events since this summary was created.

Methods inherited from interface org.forgerock.monitoring.api.instrument.Meter

builder, getId

Method Detail

builder

static DistributionSummary.Builder builder(String name)

record

default void record()

Updates the statistics kept by the summary.

record

void record(double 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

double totalAmount()

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

mean

default double mean()

max

double max()

The maximum time of a single event.

percentile

double percentile(double percentile)

The value at a specific percentile. This value is non-aggregable across dimensions.

histogramCountAtValue

double histogramCountAtValue(long value)

takeSnapshot

HistogramSnapshot takeSnapshot(boolean supportsAggregablePercentiles)

measure

default Iterable<Measurement> measure()

Description copied from interface: Meter

Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.

Specified by:

measure in interface Meter

Returns:

The set of measurements that represents the instantaneous value of this meter.