io.opentelemetry.metrics

Interface DoubleCounter

All Superinterfaces:

Instrument, SynchronousInstrument<DoubleCounter.BoundDoubleCounter>

@ThreadSafe
public interface DoubleCounter
extends SynchronousInstrument<DoubleCounter.BoundDoubleCounter>

Counter is the most common synchronous instrument. This instrument supports an add(double, 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 DoubleCounter counter =
       meter.
           .doubleCounterBuilder("allocated_resources")
           .setDescription("Total allocated resources")
           .setUnit("1")
           .build();

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

   void doSomeWork() {
      someWorkBound.add(10.2);  // Resources needed for this task.
      // Your code here.
   }
 }
 

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DoubleCounter.BoundDoubleCounter A Bound Instrument for a DoubleCounter.
static interface	DoubleCounter.Builder Builder class for DoubleCounter.

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

SynchronousInstrument.BoundInstrument

Method Summary

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

Method Detail

add

void add(double 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 labels to be associated to this recording.

Since:

0.1.0

bind

DoubleCounter.BoundDoubleCounter 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<DoubleCounter.BoundDoubleCounter>

Parameters:

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

Returns:

a Bound Instrument