Package io.opentelemetry.sdk.metrics
Class SdkDoubleCounter.SdkDoubleCounterBuilder
java.lang.Object
io.opentelemetry.sdk.metrics.SdkDoubleCounter.SdkDoubleCounterBuilder
- All Implemented Interfaces:
ExtendedDoubleCounterBuilder
,DoubleCounterBuilder
- Enclosing class:
SdkDoubleCounter
static final class SdkDoubleCounter.SdkDoubleCounterBuilder
extends Object
implements ExtendedDoubleCounterBuilder
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionSdkDoubleCounterBuilder
(SdkMeter sdkMeter, String name, String description, String unit, Advice.AdviceBuilder adviceBuilder) -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds and returns a Counter instrument with the configuration.Build an observer for this instrument to observe values from aBatchCallback
.buildWithCallback
(Consumer<ObservableDoubleMeasurement> callback) Builds an Asynchronous Counter instrument with the given callback.setAttributesAdvice
(List<AttributeKey<?>> attributes) Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this counter.setDescription
(String description) Sets the description for this instrument.Sets the unit of measure for this instrument.toString()
-
Field Details
-
builder
-
-
Constructor Details
-
SdkDoubleCounterBuilder
SdkDoubleCounterBuilder(SdkMeter sdkMeter, String name, String description, String unit, Advice.AdviceBuilder adviceBuilder)
-
-
Method Details
-
build
Description copied from interface:DoubleCounterBuilder
Builds and returns a Counter instrument with the configuration.- Specified by:
build
in interfaceDoubleCounterBuilder
- Returns:
- The Counter instrument.
-
setDescription
Description copied from interface:DoubleCounterBuilder
Sets the description for this instrument.- Specified by:
setDescription
in interfaceDoubleCounterBuilder
- Parameters:
description
- The description.- See Also:
-
setUnit
Description copied from interface:DoubleCounterBuilder
Sets the unit of measure for this instrument.- Specified by:
setUnit
in interfaceDoubleCounterBuilder
- Parameters:
unit
- The unit. Instrument units must be 63 or fewer ASCII characters.- See Also:
-
buildWithCallback
Description copied from interface:DoubleCounterBuilder
Builds an Asynchronous Counter 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 interfaceDoubleCounterBuilder
- Parameters:
callback
- A callback which observes measurements when invoked.
-
buildObserver
Description copied from interface:DoubleCounterBuilder
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.- Specified by:
buildObserver
in interfaceDoubleCounterBuilder
- Returns:
- an observable measurement that batch callbacks use to observe values.
-
setAttributesAdvice
Description copied from interface:ExtendedDoubleCounterBuilder
Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this counter.- Specified by:
setAttributesAdvice
in interfaceExtendedDoubleCounterBuilder
-
toString
-