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.

Nested classes/interfaces inherited from class org.eclipse.microprofile.metrics.Snapshot

org.eclipse.microprofile.metrics.Snapshot.HistogramBucket, org.eclipse.microprofile.metrics.Snapshot.PercentileValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.metrics.Snapshot.HistogramBucket[]	bucketValues()
void	dump(OutputStream output)	Writes the values of the snapshot to the given stream.
ConfigurationProperties	getConfigAdapter()
double	getMax()	Returns the highest value in the snapshot.
double	getMean()	Returns the weighted arithmetic mean of the values in the snapshot.
long[]	getValues()
org.eclipse.microprofile.metrics.Snapshot.PercentileValue[]	percentileValues()
long	size()	Returns the number of values in the snapshot.
String	toString()

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,
                        ConfigurationProperties configurationProperties)

Create a new Snapshot with the given values.

Parameters:

values - an unordered set of values in the reservoir

WeightedSnapshot

public WeightedSnapshot(Collection<WeightedSnapshot.WeightedSample> values)

Method Detail

size

public long size()

Returns the number of values in the snapshot.

Specified by:

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

Returns:

the number of values

getMax

public double getMax()

Returns the highest value in the snapshot.

Specified by:

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

Returns:

the highest 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

percentileValues

public org.eclipse.microprofile.metrics.Snapshot.PercentileValue[] percentileValues()

Specified by:

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

bucketValues

public org.eclipse.microprofile.metrics.Snapshot.HistogramBucket[] bucketValues()

Overrides:

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

getValues

public long[] getValues()

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

getConfigAdapter

public ConfigurationProperties getConfigAdapter()

toString

public String toString()

Overrides:

toString in class Object