Package fish.payara.microprofile.metrics.impl

Class WeightedSnapshot

java.lang.Object

org.eclipse.microprofile.metrics.Snapshot

fish.payara.microprofile.metrics.impl.WeightedSnapshot

public class WeightedSnapshot
extends org.eclipse.microprofile.metrics.Snapshot

A statistical snapshot of a WeightedSnapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WeightedSnapshot.WeightedSample	A single sample item with value and its weights for WeightedSnapshot.

Constructor Summary

Constructors

Constructor	Description
WeightedSnapshot(Collection<WeightedSnapshot.WeightedSample> values)	Create a new Snapshot with the given values.

Method Summary

Modifier and Type	Method	Description
void	dump(OutputStream output)	Writes the values of the snapshot to the given stream.
long	getMax()	Returns the highest value in the snapshot.
double	getMean()	Returns the weighted arithmetic mean of the values in the snapshot.
long	getMin()	Returns the lowest value in the snapshot.
double	getStdDev()	Returns the weighted standard deviation of the values in the snapshot.
double	getValue(double quantile)	Returns the value at the given quantile.
long[]	getValues()	Returns the entire set of values in the snapshot.
int	size()	Returns the number of values in the snapshot.
String	toString()

Methods inherited from class org.eclipse.microprofile.metrics.Snapshot

get75thPercentile, get95thPercentile, get98thPercentile, get999thPercentile, get99thPercentile, getMedian

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedSnapshot

public WeightedSnapshot(Collection<WeightedSnapshot.WeightedSample> values)

Create a new Snapshot with the given values.

Parameters:

values - an unordered set of values in the reservoir

Method Detail

getValue

public double getValue(double quantile)

Returns the value at the given quantile.

Specified by:

getValue in class org.eclipse.microprofile.metrics.Snapshot

Parameters:

quantile - a given quantile, in [0..1]

Returns:

the value in the distribution at quantile

size

public int size()

Returns the number of values in the snapshot.

Specified by:

size in class org.eclipse.microprofile.metrics.Snapshot

Returns:

the number of values

getValues

public long[] getValues()

Returns the entire set of values in the snapshot.

Specified by:

getValues in class org.eclipse.microprofile.metrics.Snapshot

Returns:

the entire set of values

getMax

public long getMax()

Returns the highest value in the snapshot.

Specified by:

getMax in class org.eclipse.microprofile.metrics.Snapshot

Returns:

the highest value

getMin

public long getMin()

Returns the lowest value in the snapshot.

Specified by:

getMin in class org.eclipse.microprofile.metrics.Snapshot

Returns:

the lowest value

getMean

public double getMean()

Returns the weighted arithmetic mean of the values in the snapshot.

Specified by:

getMean in class org.eclipse.microprofile.metrics.Snapshot

Returns:

the weighted arithmetic mean

getStdDev

public double getStdDev()

Returns the weighted standard deviation of the values in the snapshot.

Specified by:

getStdDev in class org.eclipse.microprofile.metrics.Snapshot

Returns:

the weighted standard deviation value

dump

public void dump(OutputStream output)

Writes the values of the snapshot to the given stream.

Specified by:

dump in class org.eclipse.microprofile.metrics.Snapshot

Parameters:

output - an output stream

toString

public String toString()

Overrides:

toString in class Object