Package io.opentelemetry.sdk.metrics.data

Interface HistogramPointData

All Superinterfaces:

PointData

@Immutable
public interface HistogramPointData
extends PointData

Point data for HistogramData.

Since:

1.14.0

Method Summary

Modifier and Type	Method	Description
static HistogramPointData	create(long startEpochNanos, long epochNanos, io.opentelemetry.api.common.Attributes attributes, double sum, boolean hasMin, double min, boolean hasMax, double max, List<Double> boundaries, List<Long> counts)	Create a record.
List<Double>	getBoundaries()	The bucket boundaries.
long	getCount()	The number of measurements taken.
List<Long>	getCounts()	The counts in each bucket.
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 hasMax() is true.
double	getMin()	The min of all measurements recorded, if hasMin() is true.
double	getSum()	The sum of all measurements recorded.
boolean	hasMax()	Return true if getMax() is set.
boolean	hasMin()	Return true if getMin() is set.

Methods inherited from interface io.opentelemetry.sdk.metrics.data.PointData

getAttributes, getEpochNanos, getStartEpochNanos

Method Details

create

static HistogramPointData create(long startEpochNanos,
 long epochNanos,
 io.opentelemetry.api.common.Attributes attributes,
 double sum,
 boolean hasMin,
 double min,
 boolean hasMax,
 double max,
 List<Double> boundaries,
 List<Long> counts)

Create a record.

Since:

1.50.0

getSum

double getSum()

The sum of all measurements recorded.

Returns:

the sum of recorded measurements.

getCount

long getCount()

The number of measurements taken.

Returns:

the count of recorded measurements.

hasMin

boolean hasMin()

Return true if getMin() is set.

getMin

double getMin()

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

hasMax

boolean hasMax()

Return true if getMax() is set.

getMax

double getMax()

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

getBoundaries

List<Double> getBoundaries()

The bucket boundaries. For a Histogram with N defined boundaries, e.g, [x, y, z]. There are N+1 counts: (-inf, x], (x, y], (y, z], (z, +inf).

Returns:

the read-only bucket boundaries in increasing order. do not mutate the returned object.

getCounts

List<Long> getCounts()

The counts in each bucket.

Returns:

the read-only counts in each bucket. do not mutate the returned object.

getExemplars

List<DoubleExemplarData> getExemplars()

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

Specified by:

getExemplars in interface PointData