Package io.opentelemetry.api.metrics
Interface LongGaugeBuilder
public interface LongGaugeBuilder
A builder for Gauge metric types. These can only be asynchronously collected.
- Since:
- 1.10.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault ObservableLongMeasurement
Build an observer for this instrument to observe values from aBatchCallback
.buildWithCallback
(Consumer<ObservableLongMeasurement> callback) Builds an Asynchronous Gauge instrument with the given callback.setDescription
(String description) Sets the description for this instrument.Sets the unit of measure for this instrument.
-
Method Details
-
setDescription
Sets the description for this instrument.- Parameters:
description
- The description.- See Also:
-
setUnit
Sets the unit of measure for this instrument.- Parameters:
unit
- The unit. Instrument units must be 63 or fewer ASCII characters.- See Also:
-
buildWithCallback
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
Build an observer for this instrument to observe values from aBatchCallback
.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
-