io.opentelemetry.metrics

Interface LongCounter

All Superinterfaces:

Instrument, SynchronousInstrument<LongCounter.BoundLongCounter>

@ThreadSafe
public interface LongCounter
extends SynchronousInstrument<LongCounter.BoundLongCounter>

Counter is the most common synchronous instrument. This instrument supports an add(long, Labels)` function for reporting an increment, and is restricted to non-negative increments. The default aggregation is `Sum`.

Example:

 class YourClass {
   private static final Meter meter = OpenTelemetry.getMeterRegistry().get("my_library_name");
   private static final LongCounter counter =
       meter.
           .longCounterBuilder("processed_jobs")
           .setDescription("Processed jobs")
           .setUnit("1")
           .build();

   // It is recommended that the API user keep a reference to a Bound Counter.
   private static final BoundLongCounter someWorkBound =
       counter.bind("work_name", "some_work");

   void doSomeWork() {
      // Your code here.
      someWorkBound.add(10);
   }
 }
 

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LongCounter.BoundLongCounter A Bound Instrument for a LongCounter.
static interface	LongCounter.Builder Builder class for LongCounter.

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

SynchronousInstrument.BoundInstrument

Method Summary

Modifier and Type	Method and Description
void	add(long increment, Labels labels) Adds the given increment to the current value.
LongCounter.BoundLongCounter	bind(Labels labels) Returns a Bound Instrument associated with the specified labels.

Method Detail

add

void add(long increment,
         Labels labels)

Adds the given increment to the current value. The values cannot be negative.

The value added is associated with the current Context and provided set of labels.

Parameters:

increment - the value to add.

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

Since:

0.1.0

bind

LongCounter.BoundLongCounter bind(Labels labels)

Description copied from interface: SynchronousInstrument

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 SynchronousInstrument<LongCounter.BoundLongCounter>

Parameters:

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

Returns:

a Bound Instrument