io.opentelemetry.metrics

Interface DoubleCounter

All Superinterfaces:

Counter<DoubleCounter.BoundDoubleCounter>, Instrument, InstrumentWithBinding<DoubleCounter.BoundDoubleCounter>

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

Counter metric, to report instantaneous measurement of a double value. Cumulative values can go up or stay the same, but can never go down. Cumulative values cannot be negative.

Example:

 class YourClass {

   private static final Meter meter = OpenTelemetry.getMeterRegistry().get("my_library_name");
   private static final DoubleCounter counter =
       meter.
           .doubleCounterBuilder("processed_jobs")
           .setDescription("Processed jobs")
           .setUnit("1")
           .setLabelKeys(Collections.singletonList("Key"))
           .build();
   // It is recommended that the API user keep references to a Bound Counters.
   private static final BoundDoubleCounter someWorkBound =
       counter.bind(Collections.singletonList("SomeWork"));

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

Since:

0.1.0

Nested Class Summary

Nested Classes

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

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

InstrumentWithBinding.BoundInstrument

Method Summary

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

Method Detail

add

void add(double delta,
         String... labelKeyValuePairs)

Adds the given delta to the current value. The values can be negative iff monotonic was set to false.

The value added is associated with the current Context and provided LabelSet.

Parameters:

delta - the value to add.

labelKeyValuePairs - the labels to be associated to this recording.

Since:

0.1.0

bind

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

Parameters:

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

Returns:

a Bound Instrument