Package io.opentelemetry.api.metrics

Interface DoubleGaugeBuilder

public interface DoubleGaugeBuilder
A builder for Gauge metric types. These can only be asynchronously collected.
Since:
1.10.0

  • Method Details

    • setDescription

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

    • setUnit

      DoubleGaugeBuilder 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:

    • ofLongs

      LongGaugeBuilder ofLongs()
      Sets the Gauge for recording long values.

    • buildWithCallback

      ObservableDoubleGauge buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)
      Builds an Asynchronous Gauge 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

    • build

      default DoubleGauge build()
      Builds and returns a DoubleGauge instrument with the configuration.

      NOTE: This produces a synchronous gauge which records gauge values as they occur. Most users will want to instead register an buildWithCallback(Consumer) to asynchronously observe the value of the gauge when metrics are collected.

      If using the OpenTelemetry SDK, by default gauges use last value aggregation, such that only the value of the last recorded measurement is exported.

      Returns:
      The DoubleGauge instrument.
      Since:
      1.38.0