io.opentelemetry.metrics

Interface LongMeasure

All Superinterfaces:

Instrument, InstrumentWithBinding<LongMeasure.BoundLongMeasure>, Measure<LongMeasure.BoundLongMeasure>

@ThreadSafe
public interface LongMeasure
extends Measure<LongMeasure.BoundLongMeasure>

Measure to report instantaneous measurement of a long value.

Example:

 class YourClass {

   private static final Meter meter = OpenTelemetry.getMeterRegistry().get("my_library_name");
   private static final LongMeasure measure =
       meter.
           .longMeasureBuilder("doWork_latency")
           .setDescription("gRPC Latency")
           .setUnit("ns")
           .build();
   private static final LongMeasure.BoundLongMeasure boundMeasure = measure.bind(labelset);

   void doWork() {
      long startTime = System.nanoTime();
      // Your code here.
      boundMeasure.record(System.nanoTime() - startTime);
   }
 }
 

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LongMeasure.BoundLongMeasure A Bound Instrument for a LongMeasure.
static interface	LongMeasure.Builder Builder class for LongMeasure.

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

InstrumentWithBinding.BoundInstrument

Method Summary

Modifier and Type	Method and Description
LongMeasure.BoundLongMeasure	bind(String... labelKeyValuePairs) Returns a Bound Instrument associated with the specified labels.
void	record(long value, String... labelKeyValuePairs) Records the given measurement, associated with the current Context and provided LabelSet.

Method Detail

record

void record(long value,
            String... labelKeyValuePairs)

Records the given measurement, associated with the current Context and provided LabelSet.

Parameters:

value - the measurement to record.

labelKeyValuePairs - the set of labels to be associated to this recording

Throws:

IllegalArgumentException - if value is negative.

Since:

0.3.0

bind

LongMeasure.BoundLongMeasure bind(String... labelKeyValuePairs)

Description copied from interface: InstrumentWithBinding

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.

Specified by:

bind in interface InstrumentWithBinding<LongMeasure.BoundLongMeasure>

Parameters:

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

Returns:

a Bound Instrument