Package io.opentelemetry.sdk.metrics.internal.aggregator

Class LongLastValueAggregator

java.lang.Object

io.opentelemetry.sdk.metrics.internal.aggregator.LongLastValueAggregator

All Implemented Interfaces:

Aggregator<LongPointData,LongExemplarData>

public final class LongLastValueAggregator
extends java.lang.Object
implements Aggregator<LongPointData,LongExemplarData>

Aggregator that aggregates recorded values by storing the last recorded value.

Limitation: The current implementation does not store a time when the value was recorded, so merging multiple LastValueAggregators will not preserve the ordering of records. This is not a problem because LastValueAggregator is currently only available for Observers which record all values once.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	LongLastValueAggregator.Handle

Field Summary

Fields

Modifier and Type	Field	Description
private MemoryMode	memoryMode
private java.util.function.Supplier<ExemplarReservoir<LongExemplarData>>	reservoirSupplier

Constructor Summary

Constructors

Constructor	Description
LongLastValueAggregator(java.util.function.Supplier<ExemplarReservoir<LongExemplarData>> reservoirSupplier, MemoryMode memoryMode)

Method Summary

Modifier and Type	Method	Description
void	copyPoint(LongPointData point, LongPointData toReusablePoint)	Copies point into toReusablePoint.
AggregatorHandle<LongPointData,LongExemplarData>	createHandle()	Returns a new AggregatorHandle.
LongPointData	createReusablePoint()	Creates a new reusable point.
LongPointData	diff(LongPointData previous, LongPointData current)	Returns a new DELTA point by computing the difference between two cumulative points.
void	diffInPlace(LongPointData previousReusablePoint, LongPointData currentPoint)	Resets one reusable point to be a DELTA point by computing the difference between two cumulative points.
MetricData	toMetricData(Resource resource, InstrumentationScopeInfo instrumentationScopeInfo, MetricDescriptor descriptor, java.util.Collection<LongPointData> points, AggregationTemporality temporality)	Returns the MetricData that this Aggregation will produce.
LongPointData	toPoint(Measurement measurement)	Return a new point representing the measurement.
void	toPoint(Measurement measurement, LongPointData reusablePoint)	Resets reusablePoint to represent the measurement.

Methods inherited from class java.lang.Object

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

Field Detail

reservoirSupplier

private final java.util.function.Supplier<ExemplarReservoir<LongExemplarData>> reservoirSupplier

memoryMode

private final MemoryMode memoryMode

Constructor Detail

LongLastValueAggregator

public LongLastValueAggregator(java.util.function.Supplier<ExemplarReservoir<LongExemplarData>> reservoirSupplier,
                               MemoryMode memoryMode)

Method Detail

createHandle

public AggregatorHandle<LongPointData,LongExemplarData> createHandle()

Description copied from interface: Aggregator

Returns a new AggregatorHandle. This MUST by used by the synchronous to aggregate recorded measurements during the collection cycle.

Specified by:

createHandle in interface Aggregator<LongPointData,LongExemplarData>

Returns:

a new AggregatorHandle.

diff

public LongPointData diff(LongPointData previous,
                          LongPointData current)

Description copied from interface: Aggregator

Returns a new DELTA point by computing the difference between two cumulative points.

Aggregators MUST implement diff if it can be used with asynchronous instruments.

Specified by:

diff in interface Aggregator<LongPointData,LongExemplarData>

Parameters:

previous - the previously captured point.

current - the newly captured (cumulative) point.

Returns:

The resulting delta point.

diffInPlace

public void diffInPlace(LongPointData previousReusablePoint,
                        LongPointData currentPoint)

Description copied from interface: Aggregator

Resets one reusable point to be a DELTA point by computing the difference between two cumulative points.

The delta between the two points is set on previousCumulativeReusable

Aggregators MUST implement diff if it can be used with asynchronous instruments.

Specified by:

diffInPlace in interface Aggregator<LongPointData,LongExemplarData>

Parameters:

previousReusablePoint - the previously captured point.

currentPoint - the newly captured (cumulative) point.

toPoint

public LongPointData toPoint(Measurement measurement)

Description copied from interface: Aggregator

Return a new point representing the measurement.

Aggregators MUST implement diff if it can be used with asynchronous instruments.

Specified by:

toPoint in interface Aggregator<LongPointData,LongExemplarData>

toPoint

public void toPoint(Measurement measurement,
                    LongPointData reusablePoint)

Description copied from interface: Aggregator

Resets reusablePoint to represent the measurement.

Aggregators MUST implement diff if it can be used with asynchronous instruments.

Specified by:

toPoint in interface Aggregator<LongPointData,LongExemplarData>

createReusablePoint

public LongPointData createReusablePoint()

Description copied from interface: Aggregator

Creates a new reusable point.

Specified by:

createReusablePoint in interface Aggregator<LongPointData,LongExemplarData>

copyPoint

public void copyPoint(LongPointData point,
                      LongPointData toReusablePoint)

Description copied from interface: Aggregator

Copies point into toReusablePoint.

Specified by:

copyPoint in interface Aggregator<LongPointData,LongExemplarData>

toMetricData

public MetricData toMetricData(Resource resource,
                               InstrumentationScopeInfo instrumentationScopeInfo,
                               MetricDescriptor descriptor,
                               java.util.Collection<LongPointData> points,
                               AggregationTemporality temporality)

Description copied from interface: Aggregator

Returns the MetricData that this Aggregation will produce.

Specified by:

toMetricData in interface Aggregator<LongPointData,LongExemplarData>

Parameters:

resource - the resource producing the metric.

instrumentationScopeInfo - the scope that instrumented the metric.

descriptor - the name, description and unit of the metric.

points - list of points

temporality - the temporality of the metric.

Returns:

the MetricDataType that this Aggregation will produce.