io.opentelemetry.metrics

Interface SynchronousInstrument<B extends SynchronousInstrument.BoundInstrument>

Type Parameters:

B - the specific type of Bound Instrument this instrument can provide.

All Superinterfaces:

Instrument

All Known Subinterfaces:

DoubleCounter, DoubleUpDownCounter, DoubleValueRecorder, LongCounter, LongUpDownCounter, LongValueRecorder

@ThreadSafe
public interface SynchronousInstrument<B extends SynchronousInstrument.BoundInstrument>
extends Instrument

SynchronousInstrument is an interface that defines a type of instruments that are used to report measurements synchronously. That is, when the user reports individual measurements as they occur.

Synchronous instrument events additionally have a Context associated with them, describing properties of the associated trace and distributed correlation values.

Since:

0.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SynchronousInstrument.BoundInstrument
static interface	SynchronousInstrument.Builder Builder class for SynchronousInstrument.

Method Summary

Modifier and Type	Method and Description
B	bind(String... labelKeyValuePairs) Returns a Bound Instrument associated with the specified labels.

Method Detail

bind

B bind(String... labelKeyValuePairs)

Returns a Bound Instrument associated with the specified labels. Multiples requests with the same set of labels may return the same Bound Instrument instance.

It is recommended that callers keep a reference to the Bound Instrument instead of always calling this method for every operation.

Parameters:

labelKeyValuePairs - the set of labels, as key-value pairs.

Returns:

a Bound Instrument

Throws:

NullPointerException - if labelValues is null.

Since:

0.1.0