Modifier and Type	Class and Description
public static class	Snapshot.HistogramBucket Represents a cumulative histogram bucket at the moment it was sampled from the Snapshot.
public static class	Snapshot.PercentileValue Represents a percentile and its value at the moment it was sampled from the Snapshot.

Access	Constructor and Description
public	Snapshot()

Method Summary

Modifier and Type	Method and Description
public abstract Snapshot.HistogramBucket[]	Returns: an array of `HistogramBucket` if it is available or an empty array if not available bucketValues() Returns an array of `HistogramBucket` containing the bucket and associated value of this `Snapshot` at the moment invocation.
public abstract void	dump(OutputStream an output stream output) Writes the values of the snapshot to the given stream.
public abstract double	Returns: the highest value getMax() Returns the highest value in the snapshot.
public abstract double	Returns: the arithmetic mean getMean() Returns the arithmetic mean of the values in the snapshot.
public abstract Snapshot.PercentileValue[]	Returns: an array of `PercentileValue` if it is available or an empty array if not available percentileValues() Returns an array of `PercentileValue` containing the percentiles and associated values of this `Snapshot` at the moment invocation.
public abstract long	Returns: the number of values size() Returns the number of values in the snapshot.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Snapshot	back to summary
public Snapshot()

Method Detail

bucketValues back to summary

bucketValues	back to summary
public abstract Snapshot.HistogramBucket[] bucketValues() Returns an array of `HistogramBucket` containing the bucket and associated value of this `Snapshot` at the moment invocation. Returns:Snapshot.HistogramBucket[] an array of `HistogramBucket` if it is available or an empty array if not available

public abstract Snapshot.HistogramBucket[] bucketValues()

Returns an array of HistogramBucket containing the bucket and associated value of this Snapshot at the moment invocation.

Returns:Snapshot.HistogramBucket[]: an array of HistogramBucket if it is available or an empty array if not available

dump	back to summary
public abstract void dump(OutputStream output) Writes the values of the snapshot to the given stream. Parameters output:OutputStream an output stream

dump

back to summary

public abstract void dump(OutputStream output)

Writes the values of the snapshot to the given stream.

Parameters

output:OutputStream: an output stream

getMax	back to summary
public abstract double getMax() Returns the highest value in the snapshot. Returns:double the highest value

getMax

back to summary

public abstract double getMax()

Returns the highest value in the snapshot.

Returns:double: the highest value

getMean	back to summary
public abstract double getMean() Returns the arithmetic mean of the values in the snapshot. Returns:double the arithmetic mean

getMean

back to summary

public abstract double getMean()

Returns the arithmetic mean of the values in the snapshot.

Returns:double: the arithmetic mean

percentileValues back to summary

percentileValues	back to summary
public abstract Snapshot.PercentileValue[] percentileValues() Returns an array of `PercentileValue` containing the percentiles and associated values of this `Snapshot` at the moment invocation. Returns:Snapshot.PercentileValue[] an array of `PercentileValue` if it is available or an empty array if not available

public abstract Snapshot.PercentileValue[] percentileValues()

Returns an array of PercentileValue containing the percentiles and associated values of this Snapshot at the moment invocation.

Returns:Snapshot.PercentileValue[]: an array of PercentileValue if it is available or an empty array if not available

size	back to summary
public abstract long size() Returns the number of values in the snapshot. Returns:long the number of values

size

back to summary

public abstract long size()

Returns the number of values in the snapshot.

Returns:long: the number of values

org.eclipse.microprofile.metrics back to summary

public Class Snapshot.HistogramBucket

Class Inheritance

extends Object

java.lang.Object
org.eclipse.microprofile.metrics.Snapshot.HistogramBucket

Represents a cumulative histogram bucket at the moment it was sampled from the Snapshot. The bucket of Timer will be represented in nanoseconds. See bucketValues()

Field Summary

Modifier and Type	Field and Description
private final double	bucket
private final long	count

Constructor Summary

Access	Constructor and Description
public	HistogramBucket(double the upper limit value of this bucket bucket, long count at this bucket count)

Method Summary

Modifier and Type	Method and Description
public double	Returns: the upper limit value of this bucket getBucket() Returns the upper limit value of this bucket
public long	Returns: the count of the bucket getCount() Returns the count of the bucket
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

bucket	back to summary
private final double bucket

count	back to summary
private final long count

Constructor Detail

HistogramBucket	back to summary
public HistogramBucket(double bucket, long count) Parameters bucket:double the upper limit value of this bucket count:long count at this bucket

Method Detail

getBucket	back to summary
public double getBucket() Returns the upper limit value of this bucket Returns:double the upper limit value of this bucket

getBucket

back to summary

public double getBucket()

Returns the upper limit value of this bucket

Returns:double: the upper limit value of this bucket

getCount	back to summary
public long getCount() Returns the count of the bucket Returns:long the count of the bucket

getCount

back to summary

public long getCount()

Returns the count of the bucket

Returns:long: the count of the bucket

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

org.eclipse.microprofile.metrics back to summary

public Class Snapshot.PercentileValue

Class Inheritance

extends Object

java.lang.Object
org.eclipse.microprofile.metrics.Snapshot.PercentileValue

Represents a percentile and its value at the moment it was sampled from the Snapshot. Percentile values of a Timer are represented in units of nanoseconds. See percentileValue()

Field Summary

Modifier and Type	Field and Description
private final double	percentile
private final double	value

Constructor Summary

Access	Constructor and Description
public	PercentileValue(double percentile percentile, double value of percentile value)

Method Summary

Modifier and Type	Method and Description
public double	Returns: the percentile getPercentile() Returns the percentile
public double	Returns: the value at the percentile getValue() Returns the value at percentile
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

percentile	back to summary
private final double percentile

value	back to summary
private final double value

Constructor Detail

PercentileValue	back to summary
public PercentileValue(double percentile, double value) Parameters percentile:double percentile value:double value of percentile

Method Detail

getPercentile	back to summary
public double getPercentile() Returns the percentile Returns:double the percentile

getPercentile

back to summary

public double getPercentile()

Returns the percentile

Returns:double: the percentile

getValue	back to summary
public double getValue() Returns the value at percentile Returns:double the value at the percentile

getValue

back to summary

public double getValue()

Returns the value at percentile

Returns:double: the value at the percentile

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public abstract Class Snapshot

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class Snapshot.HistogramBucket

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Snapshot.PercentileValue

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail