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

Class SdkObservableMeasurement

java.lang.Object

io.opentelemetry.sdk.metrics.internal.state.SdkObservableMeasurement

All Implemented Interfaces:

ObservableDoubleMeasurement, ObservableLongMeasurement, ObservableMeasurement

public final class SdkObservableMeasurement
extends Object
implements ObservableLongMeasurement, ObservableDoubleMeasurement

Records values from asynchronous instruments to associated AsynchronousMetricStorage.

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

Field Summary

Fields

Modifier and Type	Field	Description
private RegisteredReader	activeReader
private long	epochNanos
private final InstrumentationScopeInfo	instrumentationScopeInfo
private final InstrumentDescriptor	instrumentDescriptor
private static final Logger	logger
private final MutableMeasurement	mutableMeasurement	Only used when activeReader's memoryMode is MemoryMode.REUSABLE_DATA.
private long	startEpochNanos
private final List<AsynchronousMetricStorage<?,?>>	storages
private final ThrottlingLogger	throttlingLogger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SdkObservableMeasurement(InstrumentationScopeInfo instrumentationScopeInfo, InstrumentDescriptor instrumentDescriptor, List<AsynchronousMetricStorage<?,?>> storages)

Method Summary

Modifier and Type	Method	Description
static SdkObservableMeasurement	create(InstrumentationScopeInfo instrumentationScopeInfo, InstrumentDescriptor instrumentDescriptor, List<AsynchronousMetricStorage<?,?>> storages)	Create a SdkObservableMeasurement.
private void	doRecord(Measurement measurement)
InstrumentationScopeInfo	getInstrumentationScopeInfo()	Get the instrumentation scope info.
(package private) InstrumentDescriptor	getInstrumentDescriptor()
(package private) List<AsynchronousMetricStorage<?,?>>	getStorages()
private void	logNoActiveReader()
void	record(double value)	Records a measurement.
void	record(double value, Attributes attributes)	Records a measurement with a set of attributes.
void	record(long value)	Records a measurement.
void	record(long value, Attributes attributes)	Records a measurement with a set of attributes.
void	setActiveReader(RegisteredReader registeredReader, long startEpochNanos, long epochNanos)	Set the active reader, and clock information.
void	unsetActiveReader()	Unset the active reader.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

throttlingLogger

private final ThrottlingLogger throttlingLogger

instrumentationScopeInfo

private final InstrumentationScopeInfo instrumentationScopeInfo

instrumentDescriptor

private final InstrumentDescriptor instrumentDescriptor

storages

private final List<AsynchronousMetricStorage<?,?>> storages

mutableMeasurement

private final MutableMeasurement mutableMeasurement

Only used when activeReader's memoryMode is MemoryMode.REUSABLE_DATA.

activeReader

@Nullable
private volatile RegisteredReader activeReader

startEpochNanos

private volatile long startEpochNanos

epochNanos

private volatile long epochNanos

Constructor Details

SdkObservableMeasurement

private SdkObservableMeasurement(InstrumentationScopeInfo instrumentationScopeInfo,
 InstrumentDescriptor instrumentDescriptor,
 List<AsynchronousMetricStorage<?,?>> storages)

Method Details

create

public static SdkObservableMeasurement create(InstrumentationScopeInfo instrumentationScopeInfo,
 InstrumentDescriptor instrumentDescriptor,
 List<AsynchronousMetricStorage<?,?>> storages)

Create a SdkObservableMeasurement.

Parameters:

instrumentationScopeInfo - the instrumentation scope info of corresponding meter

instrumentDescriptor - the instrument descriptor

storages - the storages to record to

Returns:

the observable measurement

getInstrumentationScopeInfo

public InstrumentationScopeInfo getInstrumentationScopeInfo()

Get the instrumentation scope info.

setActiveReader

public void setActiveReader(RegisteredReader registeredReader,
 long startEpochNanos,
 long epochNanos)

Set the active reader, and clock information. unsetActiveReader() MUST be called after.

unsetActiveReader

public void unsetActiveReader()

Unset the active reader. Called after setActiveReader(RegisteredReader, long, long).

getInstrumentDescriptor

InstrumentDescriptor getInstrumentDescriptor()

getStorages

List<AsynchronousMetricStorage<?,?>> getStorages()

record

public void record(long value)

Description copied from interface: ObservableLongMeasurement

Records a measurement.

Specified by:

record in interface ObservableLongMeasurement

Parameters:

value - The measurement value.

record

public void record(long value,
 Attributes attributes)

Description copied from interface: ObservableLongMeasurement

Records a measurement with a set of attributes.

Specified by:

record in interface ObservableLongMeasurement

Parameters:

value - The measurement value.

attributes - A set of attributes to associate with the value.

record

public void record(double value)

Description copied from interface: ObservableDoubleMeasurement

Records a measurement.

Specified by:

record in interface ObservableDoubleMeasurement

Parameters:

value - The measurement value.

record

public void record(double value,
 Attributes attributes)

Description copied from interface: ObservableDoubleMeasurement

Records a measurement with a set of attributes.

Specified by:

record in interface ObservableDoubleMeasurement

Parameters:

value - The measurement value.

attributes - A set of attributes to associate with the value.

doRecord

private void doRecord(Measurement measurement)

logNoActiveReader

private void logNoActiveReader()