io.opentelemetry.metrics

Interface InstrumentWithBinding<B extends InstrumentWithBinding.BoundInstrument>

Type Parameters:

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

All Superinterfaces:

Instrument

All Known Subinterfaces:

Counter<H>, DoubleCounter, DoubleMeasure, LongCounter, LongMeasure, Measure<H>

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

Base interface for all metrics with bounds defined in this package.

Since:

0.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InstrumentWithBinding.BoundInstrument

Nested classes/interfaces inherited from interface io.opentelemetry.metrics.Instrument

Instrument.Builder

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