Package io.opentelemetry.sdk.metrics.internal.data

Class MutableExponentialHistogramPointData

java.lang.Object

io.opentelemetry.sdk.metrics.internal.data.MutableExponentialHistogramPointData

All Implemented Interfaces:

ExponentialHistogramPointData, PointData

public final class MutableExponentialHistogramPointData
extends java.lang.Object
implements ExponentialHistogramPointData

A mutable ExponentialHistogramPointData

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

This class is not thread-safe.

Field Summary

Fields

Modifier and Type	Field	Description
private Attributes	attributes
private long	count
private long	epochNanos
private java.util.List<DoubleExemplarData>	exemplars
private boolean	hasMax
private boolean	hasMin
private double	max
private double	min
private ExponentialHistogramBuckets	negativeBuckets
private ExponentialHistogramBuckets	positiveBuckets
private int	scale
private long	startEpochNanos
private double	sum
private long	zeroCount

Constructor Summary

Constructors

Constructor	Description
MutableExponentialHistogramPointData()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
Attributes	getAttributes()	Returns the attributes of the aggregation.
long	getCount()	Returns the number of measurements taken for this data point, including the positive bucket counts, negative bucket counts, and the zero count.
long	getEpochNanos()	Returns the end time of the aggregation in epoch nanos.
java.util.List<DoubleExemplarData>	getExemplars()	List of exemplars collected from measurements that were used to form the data point.
double	getMax()	The max of all measurements recorded, if ExponentialHistogramPointData.hasMax() is true.
double	getMin()	The min of all measurements recorded, if ExponentialHistogramPointData.hasMin() is true.
ExponentialHistogramBuckets	getNegativeBuckets()	Return the ExponentialHistogramBuckets representing the negative measurements taken for this histogram.
ExponentialHistogramBuckets	getPositiveBuckets()	Return the ExponentialHistogramBuckets representing the positive measurements taken for this histogram.
int	getScale()	Scale characterises the resolution of the histogram, with larger values of scale offering greater precision.
long	getStartEpochNanos()	Returns the start time of the aggregation in epoch nanos.
double	getSum()	Returns the sum of all measurements in the data point.
long	getZeroCount()	Returns the number of measurements equal to zero in this data point.
int	hashCode()
boolean	hasMax()	Return true if ExponentialHistogramPointData.getMax() is set.
boolean	hasMin()	Return true if ExponentialHistogramPointData.getMin() is set.
ExponentialHistogramPointData	set(int scale, double sum, long zeroCount, boolean hasMin, double min, boolean hasMax, double max, ExponentialHistogramBuckets positiveBuckets, ExponentialHistogramBuckets negativeBuckets, long startEpochNanos, long epochNanos, Attributes attributes, java.util.List<DoubleExemplarData> exemplars)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

startEpochNanos

private long startEpochNanos

epochNanos

private long epochNanos

attributes

private Attributes attributes

scale

private int scale

sum

private double sum

count

private long count

zeroCount

private long zeroCount

hasMin

private boolean hasMin

min

private double min

hasMax

private boolean hasMax

max

private double max

positiveBuckets

private ExponentialHistogramBuckets positiveBuckets

negativeBuckets

private ExponentialHistogramBuckets negativeBuckets

exemplars

private java.util.List<DoubleExemplarData> exemplars

Constructor Detail

MutableExponentialHistogramPointData

public MutableExponentialHistogramPointData()

Method Detail

getScale

public int getScale()

Description copied from interface: ExponentialHistogramPointData

Scale characterises the resolution of the histogram, with larger values of scale offering greater precision. Bucket boundaries of the histogram are located at integer powers of the base, where base = Math.pow(2, Math.pow(2, -scale)).

Specified by:

getScale in interface ExponentialHistogramPointData

Returns:

the scale.

getSum

public double getSum()

Description copied from interface: ExponentialHistogramPointData

Returns the sum of all measurements in the data point. The sum should be disregarded if there are both positive and negative measurements.

Specified by:

getSum in interface ExponentialHistogramPointData

Returns:

the sum of all measurements in this data point.

getCount

public long getCount()

Description copied from interface: ExponentialHistogramPointData

Returns the number of measurements taken for this data point, including the positive bucket counts, negative bucket counts, and the zero count.

Specified by:

getCount in interface ExponentialHistogramPointData

Returns:

the number of measurements in this data point.

getZeroCount

public long getZeroCount()

Description copied from interface: ExponentialHistogramPointData

Returns the number of measurements equal to zero in this data point.

Specified by:

getZeroCount in interface ExponentialHistogramPointData

Returns:

the number of values equal to zero.

hasMin

public boolean hasMin()

Description copied from interface: ExponentialHistogramPointData

Return true if ExponentialHistogramPointData.getMin() is set.

Specified by:

hasMin in interface ExponentialHistogramPointData

getMin

public double getMin()

Description copied from interface: ExponentialHistogramPointData

The min of all measurements recorded, if ExponentialHistogramPointData.hasMin() is true. If ExponentialHistogramPointData.hasMin() is false, the response should be ignored.

Specified by:

getMin in interface ExponentialHistogramPointData

hasMax

public boolean hasMax()

Description copied from interface: ExponentialHistogramPointData

Return true if ExponentialHistogramPointData.getMax() is set.

Specified by:

hasMax in interface ExponentialHistogramPointData

getMax

public double getMax()

Description copied from interface: ExponentialHistogramPointData

The max of all measurements recorded, if ExponentialHistogramPointData.hasMax() is true. If ExponentialHistogramPointData.hasMax() is false, the response should be ignored.

Specified by:

getMax in interface ExponentialHistogramPointData

getPositiveBuckets

public ExponentialHistogramBuckets getPositiveBuckets()

Description copied from interface: ExponentialHistogramPointData

Return the ExponentialHistogramBuckets representing the positive measurements taken for this histogram.

Specified by:

getPositiveBuckets in interface ExponentialHistogramPointData

Returns:

the positive buckets.

getNegativeBuckets

public ExponentialHistogramBuckets getNegativeBuckets()

Description copied from interface: ExponentialHistogramPointData

Return the ExponentialHistogramBuckets representing the negative measurements taken for this histogram.

Specified by:

getNegativeBuckets in interface ExponentialHistogramPointData

Returns:

the negative buckets.

getStartEpochNanos

public long getStartEpochNanos()

Description copied from interface: PointData

Returns the start time of the aggregation in epoch nanos.

Specified by:

getStartEpochNanos in interface PointData

getEpochNanos

public long getEpochNanos()

Description copied from interface: PointData

Returns the end time of the aggregation in epoch nanos.

Specified by:

getEpochNanos in interface PointData

getAttributes

public Attributes getAttributes()

Description copied from interface: PointData

Returns the attributes of the aggregation.

Specified by:

getAttributes in interface PointData

getExemplars

public java.util.List<DoubleExemplarData> getExemplars()

Description copied from interface: ExponentialHistogramPointData

List of exemplars collected from measurements that were used to form the data point.

Specified by:

getExemplars in interface ExponentialHistogramPointData

Specified by:

getExemplars in interface PointData

set

public ExponentialHistogramPointData set(int scale,
                                         double sum,
                                         long zeroCount,
                                         boolean hasMin,
                                         double min,
                                         boolean hasMax,
                                         double max,
                                         ExponentialHistogramBuckets positiveBuckets,
                                         ExponentialHistogramBuckets negativeBuckets,
                                         long startEpochNanos,
                                         long epochNanos,
                                         Attributes attributes,
                                         java.util.List<DoubleExemplarData> exemplars)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object