Package io.opentelemetry.api.metrics
Interface DoubleUpDownCounterBuilder
-
- All Known Subinterfaces:
ExtendedDoubleUpDownCounterBuilder
- All Known Implementing Classes:
DefaultMeter.NoopDoubleUpDownCounterBuilder
,ExtendedDefaultMeter.NoopDoubleUpDownCounterBuilder
,SdkDoubleUpDownCounter.SdkDoubleUpDownCounterBuilder
public interface DoubleUpDownCounterBuilder
Builder class forDoubleUpDownCounter
.- Since:
- 1.10.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DoubleUpDownCounter
build()
Builds and returns an UpDownCounter instrument with the configuration.default ObservableDoubleMeasurement
buildObserver()
Build an observer for this instrument to observe values from aBatchCallback
.ObservableDoubleUpDownCounter
buildWithCallback(java.util.function.Consumer<ObservableDoubleMeasurement> callback)
Builds an Asynchronous UpDownCounter instrument with the given callback.DoubleUpDownCounterBuilder
setDescription(java.lang.String description)
Sets the description for this instrument.DoubleUpDownCounterBuilder
setUnit(java.lang.String unit)
Sets the unit of measure for this instrument.
-
-
-
Method Detail
-
setDescription
DoubleUpDownCounterBuilder setDescription(java.lang.String description)
Sets the description for this instrument.- Parameters:
description
- The description.- See Also:
- Instrument Description
-
setUnit
DoubleUpDownCounterBuilder setUnit(java.lang.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:
- Instrument Unit
-
build
DoubleUpDownCounter build()
Builds and returns an UpDownCounter instrument with the configuration.- Returns:
- The UpDownCounter instrument.
-
buildWithCallback
ObservableDoubleUpDownCounter buildWithCallback(java.util.function.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
- A callback which observes measurements when invoked.
-
buildObserver
default ObservableDoubleMeasurement 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
-
-