Package io.opentelemetry.api.metrics

Interface DoubleCounterBuilder

public interface DoubleCounterBuilder
Builder class for DoubleCounter.
Since:
1.10.0

  • Method Details

    • setDescription

      DoubleCounterBuilder setDescription(String description)
      Sets the description for this instrument.
      Parameters:
      description - The description.
      See Also:

    • setUnit

      DoubleCounterBuilder setUnit(String unit)
      Sets the unit of measure for this instrument.
      Parameters:
      unit - The unit. Instrument units must be 63 or fewer ASCII characters.
      See Also:

    • build

      DoubleCounter build()
      Builds and returns a Counter instrument with the configuration.
      Returns:
      The Counter instrument.

    • buildWithCallback

      ObservableDoubleCounter buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)
      Builds an Asynchronous Counter instrument with the given callback.

      The callback will be called when the instrument is being observed.

      Callbacks are expected to abide by the following restrictions:

      • Run in a finite amount of time.
      • Safe to call repeatedly, across multiple threads.
      Parameters:
      callback - A callback which observes measurements when invoked.

    • buildObserver

      default ObservableDoubleMeasurement buildObserver()
      Build an observer for this instrument to observe values from a BatchCallback.

      This observer MUST be registered when creating a batchCallback, which records to it. Values observed outside registered callbacks are ignored.

      Returns:
      an observable measurement that batch callbacks use to observe values.
      Since:
      1.15.0