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

Modifier and Type	Field	Description
private final InstrumentBuilder	builder

Constructor Summary

Constructors

Constructor	Description
SdkDoubleCounterBuilder(SdkMeter sdkMeter, String name, String description, String unit, Advice.AdviceBuilder adviceBuilder)

Method Summary

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 a BatchCallback.
ObservableDoubleCounter	buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)	Builds an Asynchronous Counter instrument with the given callback.
ExtendedDoubleCounterBuilder	setAttributesAdvice(List<AttributeKey<?>> attributes)	Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this counter.
DoubleCounterBuilder	setDescription(String description)	Sets the description for this instrument.
DoubleCounterBuilder	setUnit(String unit)	Sets the unit of measure for this instrument.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

builder

private final InstrumentBuilder builder

Constructor Details

SdkDoubleCounterBuilder

SdkDoubleCounterBuilder(SdkMeter sdkMeter,
 String name,
 String description,
 String unit,
 Advice.AdviceBuilder adviceBuilder)

Method Details

build

public SdkDoubleCounter build()

Description copied from interface: DoubleCounterBuilder

Builds and returns a Counter instrument with the configuration.

Specified by:

build in interface DoubleCounterBuilder

Returns:

The Counter instrument.

setDescription

public DoubleCounterBuilder setDescription(String description)

Description copied from interface: DoubleCounterBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface DoubleCounterBuilder

Parameters:

description - The description.

See Also:

• Instrument Description

setUnit

public DoubleCounterBuilder setUnit(String unit)

Description copied from interface: DoubleCounterBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface DoubleCounterBuilder

Parameters:

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

See Also:

• Instrument Unit

buildWithCallback

public ObservableDoubleCounter buildWithCallback(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 interface DoubleCounterBuilder

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 a BatchCallback.

This observer MUST be registered when creating a batchCallback, which records to it. Values observed outside registered callbacks are ignored.

Specified by:

buildObserver in interface DoubleCounterBuilder

Returns:

an observable measurement that batch callbacks use to observe values.

setAttributesAdvice

public ExtendedDoubleCounterBuilder setAttributesAdvice(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 interface ExtendedDoubleCounterBuilder

toString

public String toString()

Overrides:

toString in class Object