Class DefaultMeter.NoopLongGaugeBuilder

java.lang.Object
io.opentelemetry.api.metrics.DefaultMeter.NoopLongGaugeBuilder
All Implemented Interfaces:
LongGaugeBuilder
Enclosing class:
DefaultMeter

private static class DefaultMeter.NoopLongGaugeBuilder extends Object implements LongGaugeBuilder
  • Field Details

  • Constructor Details

    • NoopLongGaugeBuilder

      private NoopLongGaugeBuilder()
  • Method Details

    • setDescription

      public LongGaugeBuilder setDescription(String description)
      Description copied from interface: LongGaugeBuilder
      Sets the description for this instrument.
      Specified by:
      setDescription in interface LongGaugeBuilder
      Parameters:
      description - The description.
      See Also:
    • setUnit

      public LongGaugeBuilder setUnit(String unit)
      Description copied from interface: LongGaugeBuilder
      Sets the unit of measure for this instrument.
      Specified by:
      setUnit in interface LongGaugeBuilder
      Parameters:
      unit - The unit. Instrument units must be 63 or fewer ASCII characters.
      See Also:
    • buildWithCallback

      public ObservableLongGauge buildWithCallback(Consumer<ObservableLongMeasurement> callback)
      Description copied from interface: LongGaugeBuilder
      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.
      Specified by:
      buildWithCallback in interface LongGaugeBuilder
      Parameters:
      callback - A callback which observes measurements when invoked.
    • buildObserver

      public ObservableLongMeasurement buildObserver()
      Description copied from interface: LongGaugeBuilder
      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.

      Specified by:
      buildObserver in interface LongGaugeBuilder
      Returns:
      an observable measurement that batch callbacks use to observe values.
    • build

      public LongGauge build()
      Description copied from interface: LongGaugeBuilder
      Builds and returns a LongGauge 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 LongGaugeBuilder.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.

      Specified by:
      build in interface LongGaugeBuilder
      Returns:
      The LongGauge instrument.