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.

Method Summary

Modifier and Type	Method	Description
static SdkObservableMeasurement	create(InstrumentationScopeInfo instrumentationScopeInfo, InstrumentDescriptor instrumentDescriptor, List<AsynchronousMetricStorage<?,?>> storages)	Create a SdkObservableMeasurement.
InstrumentationScopeInfo	getInstrumentationScopeInfo()	Get the instrumentation scope info.
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 Object

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

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).

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.