Class CallbackRegistration

java.lang.Object

io.opentelemetry.sdk.metrics.internal.state.CallbackRegistration

public final class CallbackRegistration
extends Object

A registered callback.

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 final Runnable	callback
private final boolean	hasStorages
private final List<InstrumentDescriptor>	instrumentDescriptors
private static final Logger	logger
private final List<SdkObservableMeasurement>	observableMeasurements
private final ThrottlingLogger	throttlingLogger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CallbackRegistration(List<SdkObservableMeasurement> observableMeasurements, Runnable callback)

Method Summary

Modifier and Type	Method	Description
static CallbackRegistration	create(List<SdkObservableMeasurement> observableMeasurements, Runnable runnable)	Create a callback registration.
void	invokeCallback(RegisteredReader reader, long startEpochNanos, long epochNanos)
String	toString()

Methods inherited from class Object

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

Field Details

logger

private static final Logger logger

throttlingLogger

private final ThrottlingLogger throttlingLogger

observableMeasurements

private final List<SdkObservableMeasurement> observableMeasurements

callback

private final Runnable callback

instrumentDescriptors

private final List<InstrumentDescriptor> instrumentDescriptors

hasStorages

private final boolean hasStorages

Constructor Details

CallbackRegistration

private CallbackRegistration(List<SdkObservableMeasurement> observableMeasurements,
 Runnable callback)

Method Details

create

public static CallbackRegistration create(List<SdkObservableMeasurement> observableMeasurements,
 Runnable runnable)

Create a callback registration.

The observableMeasurements define the set of measurements the runnable may record to. The active reader of each observableMeasurements is set via SdkObservableMeasurement.setActiveReader(RegisteredReader, long, long) before runnable is called, and set to null afterwards.

Parameters:

observableMeasurements - the measurements that the runnable may record to

runnable - the callback

Returns:

the callback registration

toString

public String toString()

Overrides:

toString in class Object

invokeCallback

public void invokeCallback(RegisteredReader reader,
 long startEpochNanos,
 long epochNanos)