Record Class ExternalSummary

java.lang.Object

java.lang.Record

org.hyperledger.besu.plugin.services.metrics.ExternalSummary

Record Components:

count - the number of observations

sum - the sum of all the observations

quantiles - a list of quantiles with values

public record ExternalSummary(long count, double sum, List<ExternalSummary.Quantile> quantiles)
extends Record

Record of summary data the is kept outside the metric system. Useful when existing libraries calculate the summary data on their own, and we want to export that summary via the configured metric system. A notable example are RocksDB statistics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ExternalSummary.Quantile	Represent a single quantile and its value

Constructor Summary

Constructors

Constructor	Description
ExternalSummary(long count, double sum, List<ExternalSummary.Quantile> quantiles)	Creates an instance of a ExternalSummary record class.

Method Summary

Modifier and Type	Method	Description
long	count()	Returns the value of the count record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<ExternalSummary.Quantile>	quantiles()	Returns the value of the quantiles record component.
double	sum()	Returns the value of the sum record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExternalSummary

public ExternalSummary(long count,
 double sum,
 List<ExternalSummary.Quantile> quantiles)

Creates an instance of a ExternalSummary record class.

Parameters:

count - the value for the count record component

sum - the value for the sum record component

quantiles - the value for the quantiles record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

count

public long count()

Returns the value of the count record component.

Returns:

the value of the count record component

sum

public double sum()

Returns the value of the sum record component.

Returns:

the value of the sum record component

quantiles

public List<ExternalSummary.Quantile> quantiles()

Returns the value of the quantiles record component.

Returns:

the value of the quantiles record component