Interface DoubleCounter

  • All Superinterfaces:
    Instrument, SynchronousInstrument<BoundDoubleCounter>

    @ThreadSafe
    public interface DoubleCounter
    extends SynchronousInstrument<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.getMeterProvider().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.
       }
     }
     
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(double increment)
      Adds the given increment to the current value.
      void add​(double increment, Labels labels)
      Adds the given increment to the current value.
      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.
      • add

        void add​(double increment)
        Adds the given increment to the current value. The values cannot be negative.

        The value added is associated with the current Context and with empty labels.

        Parameters:
        increment - the value to add.
      • bind

        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<BoundDoubleCounter>
        Parameters:
        labels - the set of labels, as key-value pairs.
        Returns:
        a Bound Instrument