io.opentelemetry.metrics

Interface AsynchronousInstrument<R>

Type Parameters:

R - the callback Result type.

All Superinterfaces:

Instrument

All Known Subinterfaces:

DoubleSumObserver, DoubleUpDownSumObserver, DoubleValueObserver, LongSumObserver, LongUpDownSumObserver, LongValueObserver

@ThreadSafe
public interface AsynchronousInstrument<R>
extends Instrument

AsynchronousInstrument is an interface that defines a type of instruments that are used to report measurements asynchronously.

They are reported by a callback, once per collection interval, and lack Context. They are permitted to report only one value per distinct label set per period. If the application observes multiple values for the same label set, in a single callback, the last value is the only value kept.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AsynchronousInstrument.Builder Builder class for AsynchronousInstrument.
static interface	AsynchronousInstrument.Callback<R> A Callback for a AsynchronousInstrument.

Method Summary

Modifier and Type	Method and Description
void	setCallback(AsynchronousInstrument.Callback<R> callback) Sets a callback that gets executed every collection interval.

Method Detail

setCallback

void setCallback(AsynchronousInstrument.Callback<R> callback)

Sets a callback that gets executed every collection interval.

Evaluation is deferred until needed, if this AsynchronousInstrument metric is not exported then it will never be called.

Parameters:

callback - the callback to be executed before export.

Since:

0.1.0