Class FixedSizeExemplarReservoir<T extends ExemplarData>

java.lang.Object

io.opentelemetry.sdk.metrics.internal.exemplar.FixedSizeExemplarReservoir<T>

All Implemented Interfaces:

ExemplarReservoir<T>

Direct Known Subclasses:

HistogramExemplarReservoir, RandomFixedSizeExemplarReservoir

abstract class FixedSizeExemplarReservoir<T extends ExemplarData>
extends Object
implements ExemplarReservoir<T>

Base for fixed-size reservoir sampling of Exemplars.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	hasMeasurements
private final BiFunction<ReservoirCell, Attributes, T>	mapAndResetCell
private final ReservoirCellSelector	reservoirCellSelector
private final ReservoirCell[]	storage

Constructor Summary

Constructors

Constructor	Description
FixedSizeExemplarReservoir(Clock clock, int size, ReservoirCellSelector reservoirCellSelector, BiFunction<ReservoirCell, Attributes, T> mapAndResetCell)	Instantiates an exemplar reservoir of fixed size.

Method Summary

Modifier and Type	Method	Description
List<T>	collectAndReset(Attributes pointAttributes)	Returns an immutable list of Exemplars for exporting from the current reservoir.
void	offerDoubleMeasurement(double value, Attributes attributes, Context context)	Offers a double measurement to be sampled.
void	offerLongMeasurement(long value, Attributes attributes, Context context)	Offers a long measurement to be sampled.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

storage

private final ReservoirCell[] storage

reservoirCellSelector

private final ReservoirCellSelector reservoirCellSelector

mapAndResetCell

private final BiFunction<ReservoirCell, Attributes, T extends ExemplarData> mapAndResetCell

hasMeasurements

private volatile boolean hasMeasurements

Constructor Details

FixedSizeExemplarReservoir

FixedSizeExemplarReservoir(Clock clock,
 int size,
 ReservoirCellSelector reservoirCellSelector,
 BiFunction<ReservoirCell, Attributes, T> mapAndResetCell)

Instantiates an exemplar reservoir of fixed size.

Method Details

offerLongMeasurement

public void offerLongMeasurement(long value,
 Attributes attributes,
 Context context)

Description copied from interface: ExemplarReservoir

Offers a long measurement to be sampled.

Specified by:

offerLongMeasurement in interface ExemplarReservoir<T extends ExemplarData>

offerDoubleMeasurement

public void offerDoubleMeasurement(double value,
 Attributes attributes,
 Context context)

Description copied from interface: ExemplarReservoir

Offers a double measurement to be sampled.

Specified by:

offerDoubleMeasurement in interface ExemplarReservoir<T extends ExemplarData>

collectAndReset

public List<T> collectAndReset(Attributes pointAttributes)

Description copied from interface: ExemplarReservoir

Returns an immutable list of Exemplars for exporting from the current reservoir.

Additionally, clears the reservoir for the next sampling period.

Specified by:

collectAndReset in interface ExemplarReservoir<T extends ExemplarData>

Parameters:

pointAttributes - the Attributes associated with the metric point. ExemplarDatas should filter these out of their final data state.

Returns:

An (immutable) list of sampled exemplars for this point. Implementers are expected to filter out pointAttributes from the original recorded attributes.