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 java.lang.Object implements ExtendedDoubleCounterBuilder
-
-
Field Summary
Fields Modifier and Type Field Description private InstrumentBuilder
builder
-
Constructor Summary
Constructors Constructor Description SdkDoubleCounterBuilder(SdkMeter sdkMeter, java.lang.String name, java.lang.String description, java.lang.String unit, Advice.AdviceBuilder adviceBuilder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SdkDoubleCounter
build()
Builds and returns a Counter instrument with the configuration.ObservableDoubleMeasurement
buildObserver()
Build an observer for this instrument to observe values from aBatchCallback
.ObservableDoubleCounter
buildWithCallback(java.util.function.Consumer<ObservableDoubleMeasurement> callback)
Builds an Asynchronous Counter instrument with the given callback.ExtendedDoubleCounterBuilder
setAttributesAdvice(java.util.List<AttributeKey<?>> attributes)
Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this counter.DoubleCounterBuilder
setDescription(java.lang.String description)
Sets the description for this instrument.DoubleCounterBuilder
setUnit(java.lang.String unit)
Sets the unit of measure for this instrument.java.lang.String
toString()
-
-
-
Field Detail
-
builder
private final InstrumentBuilder builder
-
-
Constructor Detail
-
SdkDoubleCounterBuilder
SdkDoubleCounterBuilder(SdkMeter sdkMeter, java.lang.String name, java.lang.String description, java.lang.String unit, Advice.AdviceBuilder adviceBuilder)
-
-
Method Detail
-
build
public SdkDoubleCounter 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
public DoubleCounterBuilder setDescription(java.lang.String description)
Description copied from interface:DoubleCounterBuilder
Sets the description for this instrument.- Specified by:
setDescription
in interfaceDoubleCounterBuilder
- Parameters:
description
- The description.- See Also:
- Instrument Description
-
setUnit
public DoubleCounterBuilder setUnit(java.lang.String unit)
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:
- Instrument Unit
-
buildWithCallback
public ObservableDoubleCounter buildWithCallback(java.util.function.Consumer<ObservableDoubleMeasurement> callback)
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
public ObservableDoubleMeasurement 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
public ExtendedDoubleCounterBuilder setAttributesAdvice(java.util.List<AttributeKey<?>> attributes)
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
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-