Package io.opentelemetry.sdk.metrics.internal.state

Class DefaultSynchronousMetricStorage<T extends PointData,U extends ExemplarData>

java.lang.Object

io.opentelemetry.sdk.metrics.internal.state.DefaultSynchronousMetricStorage<T,U>

All Implemented Interfaces:

MetricStorage, SynchronousMetricStorage, WriteableMetricStorage

public final class DefaultSynchronousMetricStorage<T extends PointData,U extends ExemplarData>
extends Object
implements SynchronousMetricStorage

Stores aggregated MetricData for synchronous instruments.

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
private static class	DefaultSynchronousMetricStorage.AggregatorHolder<T extends PointData,U extends ExemplarData>

Field Summary

Fields

Modifier and Type	Field	Description
private final AggregationTemporality	aggregationTemporality
private final Aggregator<T,U>	aggregator
private final ConcurrentLinkedQueue<AggregatorHandle<T,U>>	aggregatorHandlePool
private DefaultSynchronousMetricStorage.AggregatorHolder<T,U>	aggregatorHolder
private final AttributesProcessor	attributesProcessor
private static final Logger	internalLogger
private final ThrottlingLogger	logger
private final int	maxCardinality	This field is set to 1 less than the actual intended cardinality limit, allowing the last slot to be filled by the MetricStorage.CARDINALITY_OVERFLOW series.
private final MemoryMode	memoryMode
private final MetricDescriptor	metricDescriptor
private ConcurrentHashMap<Attributes,AggregatorHandle<T,U>>	previousCollectionAggregatorHandles
private final RegisteredReader	registeredReader
private final ArrayList<T>	reusableResultList

Fields inherited from interface io.opentelemetry.sdk.metrics.internal.state.MetricStorage

CARDINALITY_OVERFLOW, DEFAULT_MAX_CARDINALITY

Constructor Summary

Constructors

Constructor	Description
DefaultSynchronousMetricStorage(RegisteredReader registeredReader, MetricDescriptor metricDescriptor, Aggregator<T,U> aggregator, AttributesProcessor attributesProcessor, int maxCardinality)

Method Summary

Modifier and Type	Method	Description
MetricData	collect(Resource resource, InstrumentationScopeInfo instrumentationScopeInfo, long startEpochNanos, long epochNanos)	Collects the metrics from this storage.
private AggregatorHandle<T,U>	getAggregatorHandle(ConcurrentHashMap<Attributes,AggregatorHandle<T,U>> aggregatorHandles, Attributes attributes, Context context)
(package private) Queue<AggregatorHandle<T,U>>	getAggregatorHandlePool()
private DefaultSynchronousMetricStorage.AggregatorHolder<T,U>	getHolderForRecord()	Obtain the AggregatorHolder for recording measurements, re-reading the volatile this.aggregatorHolder until we access one where recordsInProgress is even.
MetricDescriptor	getMetricDescriptor()	Returns a description of the metric produced in this storage.
boolean	isEnabled()	Returns true if the storage is actively recording measurements, and false otherwise (i.e.
void	recordDouble(double value, Attributes attributes, Context context)	Records a measurement.
void	recordLong(long value, Attributes attributes, Context context)	Records a measurement.
private void	releaseHolderForRecord(DefaultSynchronousMetricStorage.AggregatorHolder<T,U> aggregatorHolder)	Called on the DefaultSynchronousMetricStorage.AggregatorHolder obtained from getHolderForRecord() to indicate that recording is complete, and it is safe to collect.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.sdk.metrics.internal.state.MetricStorage

isEmpty

Field Details

internalLogger

private static final Logger internalLogger

logger

private final ThrottlingLogger logger

registeredReader

private final RegisteredReader registeredReader

metricDescriptor

private final MetricDescriptor metricDescriptor

aggregationTemporality

private final AggregationTemporality aggregationTemporality

aggregator

private final Aggregator<T extends PointData,U extends ExemplarData> aggregator

aggregatorHolder

private volatile DefaultSynchronousMetricStorage.AggregatorHolder<T extends PointData,U extends ExemplarData> aggregatorHolder

attributesProcessor

private final AttributesProcessor attributesProcessor

memoryMode

private final MemoryMode memoryMode

reusableResultList

private final ArrayList<T extends PointData> reusableResultList

previousCollectionAggregatorHandles

private volatile ConcurrentHashMap<Attributes,AggregatorHandle<T extends PointData,U extends ExemplarData>> previousCollectionAggregatorHandles

maxCardinality

private final int maxCardinality

This field is set to 1 less than the actual intended cardinality limit, allowing the last slot to be filled by the MetricStorage.CARDINALITY_OVERFLOW series.

aggregatorHandlePool

private final ConcurrentLinkedQueue<AggregatorHandle<T extends PointData,U extends ExemplarData>> aggregatorHandlePool

Constructor Details

DefaultSynchronousMetricStorage

DefaultSynchronousMetricStorage(RegisteredReader registeredReader,
 MetricDescriptor metricDescriptor,
 Aggregator<T,U> aggregator,
 AttributesProcessor attributesProcessor,
 int maxCardinality)

Method Details

getAggregatorHandlePool

Queue<AggregatorHandle<T,U>> getAggregatorHandlePool()

recordLong

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

Description copied from interface: WriteableMetricStorage

Records a measurement.

Specified by:

recordLong in interface WriteableMetricStorage

recordDouble

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

Description copied from interface: WriteableMetricStorage

Records a measurement.

Specified by:

recordDouble in interface WriteableMetricStorage

isEnabled

public boolean isEnabled()

Description copied from interface: WriteableMetricStorage

Returns true if the storage is actively recording measurements, and false otherwise (i.e. noop / empty metric storage is installed).

Specified by:

isEnabled in interface WriteableMetricStorage

getHolderForRecord

private DefaultSynchronousMetricStorage.AggregatorHolder<T,U> getHolderForRecord()

Obtain the AggregatorHolder for recording measurements, re-reading the volatile this.aggregatorHolder until we access one where recordsInProgress is even. Collect sets recordsInProgress to odd as a signal that AggregatorHolder is stale and is being replaced. Record operations increment recordInProgress by 2. Callers MUST call releaseHolderForRecord(AggregatorHolder) when record operation completes to signal to that its safe to proceed with Collect operations.

releaseHolderForRecord

private void releaseHolderForRecord(DefaultSynchronousMetricStorage.AggregatorHolder<T,U> aggregatorHolder)

Called on the DefaultSynchronousMetricStorage.AggregatorHolder obtained from getHolderForRecord() to indicate that recording is complete, and it is safe to collect.

getAggregatorHandle

private AggregatorHandle<T,U> getAggregatorHandle(ConcurrentHashMap<Attributes,AggregatorHandle<T,U>> aggregatorHandles,
 Attributes attributes,
 Context context)

collect

public MetricData collect(Resource resource,
 InstrumentationScopeInfo instrumentationScopeInfo,
 long startEpochNanos,
 long epochNanos)

Description copied from interface: MetricStorage

Collects the metrics from this storage. If storing AggregationTemporality.DELTA metrics, reset for the next collection period.

Note: This is a stateful operation and will reset any interval-related state for the collector.

Specified by:

collect in interface MetricStorage

Parameters:

resource - The resource associated with the metrics.

instrumentationScopeInfo - The instrumentation scope generating the metrics.

startEpochNanos - The start timestamp for this SDK.

epochNanos - The timestamp for this collection.

Returns:

The MetricData from this collection period.

getMetricDescriptor

public MetricDescriptor getMetricDescriptor()

Description copied from interface: MetricStorage

Returns a description of the metric produced in this storage.

Specified by:

getMetricDescriptor in interface MetricStorage