OpenTelemetry Java 1.49.0 · io.opentelemetry.api.metrics.DoubleUpDownCounterBuilder

Method Summary

Modifier and Type	Method and Description
public DoubleUpDownCounter	Returns: The UpDownCounter instrument. build() Builds and returns an UpDownCounter instrument with the configuration.
public default ObservableDoubleMeasurement	Returns: an observable measurement that batch callbacks use to observe values. buildObserver() Build an observer for this instrument to observe values from a `BatchCallback`.
public ObservableDoubleUpDownCounter	buildWithCallback(Consumer<ObservableDoubleMeasurement> A callback which observes measurements when invoked. callback) Builds an Asynchronous UpDownCounter instrument with the given callback.
public DoubleUpDownCounterBuilder	setDescription(String The description. description) Sets the description for this instrument.
public DoubleUpDownCounterBuilder	setUnit(String The unit. Instrument units must be 63 or fewer ASCII characters. unit) Sets the unit of measure for this instrument.

build	back to summary
public DoubleUpDownCounter build() Builds and returns an UpDownCounter instrument with the configuration. Returns:DoubleUpDownCounter The UpDownCounter instrument.

build

Builds and returns an UpDownCounter instrument with the configuration.

buildObserver back to summary

buildObserver	back to summary
public 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:ObservableDoubleMeasurement an observable measurement that batch callbacks use to observe values. Since 1.15.0

public 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:ObservableDoubleMeasurement: an observable measurement that batch callbacks use to observe values.
Since: 1.15.0

buildWithCallback	back to summary
public ObservableDoubleUpDownCounter buildWithCallback(Consumer<ObservableDoubleMeasurement> callback) Builds an Asynchronous UpDownCounter 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:Consumer<ObservableDoubleMeasurement> A callback which observes measurements when invoked.

buildWithCallback

Builds an Asynchronous UpDownCounter 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:

Parameters

callback:Consumer<ObservableDoubleMeasurement>: A callback which observes measurements when invoked.

setDescription	back to summary
public DoubleUpDownCounterBuilder setDescription(String description) Sets the description for this instrument. Parameters description:String The description. See Also Instrument Description

setDescription

public DoubleUpDownCounterBuilder setDescription(String description)

Sets the description for this instrument.

Parameters

See Also

Instrument Description

setUnit	back to summary
public DoubleUpDownCounterBuilder setUnit(String unit) Sets the unit of measure for this instrument. Parameters unit:String The unit. Instrument units must be 63 or fewer ASCII characters. See Also Instrument Unit

setUnit

Sets the unit of measure for this instrument.

Parameters

unit:String: The unit. Instrument units must be 63 or fewer ASCII characters.

See Also

Instrument Unit