Package io.opentelemetry.sdk.metrics

Class SdkLongUpDownCounter.SdkLongUpDownCounterBuilder

java.lang.Object

io.opentelemetry.sdk.metrics.SdkLongUpDownCounter.SdkLongUpDownCounterBuilder

All Implemented Interfaces:

ExtendedLongUpDownCounterBuilder, LongUpDownCounterBuilder

Enclosing class:

SdkLongUpDownCounter

static final class SdkLongUpDownCounter.SdkLongUpDownCounterBuilder
extends java.lang.Object
implements ExtendedLongUpDownCounterBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private InstrumentBuilder	builder

Constructor Summary

Constructors

Constructor	Description
SdkLongUpDownCounterBuilder(SdkMeter sdkMeter, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
LongUpDownCounter	build()	Builds and returns an UpDownCounter instrument with the configuration.
ObservableLongMeasurement	buildObserver()	Build an observer for this instrument to observe values from a BatchCallback.
ObservableLongUpDownCounter	buildWithCallback(java.util.function.Consumer<ObservableLongMeasurement> callback)	Builds an Asynchronous UpDownCounter instrument with the given callback.
DoubleUpDownCounterBuilder	ofDoubles()	Sets the Counter for recording double values.
ExtendedLongUpDownCounterBuilder	setAttributesAdvice(java.util.List<AttributeKey<?>> attributes)	Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this up down counter.
LongUpDownCounterBuilder	setDescription(java.lang.String description)	Sets the description for this instrument.
LongUpDownCounterBuilder	setUnit(java.lang.String unit)	Sets the unit of measure for this instrument.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

builder

private final InstrumentBuilder builder

Constructor Detail

SdkLongUpDownCounterBuilder

SdkLongUpDownCounterBuilder(SdkMeter sdkMeter,
                            java.lang.String name)

Method Detail

setDescription

public LongUpDownCounterBuilder setDescription(java.lang.String description)

Description copied from interface: LongUpDownCounterBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface LongUpDownCounterBuilder

Parameters:

description - The description.

See Also:

Instrument Description

setUnit

public LongUpDownCounterBuilder setUnit(java.lang.String unit)

Description copied from interface: LongUpDownCounterBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface LongUpDownCounterBuilder

Parameters:

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

See Also:

Instrument Unit

build

public LongUpDownCounter build()

Description copied from interface: LongUpDownCounterBuilder

Builds and returns an UpDownCounter instrument with the configuration.

Specified by:

build in interface LongUpDownCounterBuilder

Returns:

The UpDownCounter instrument.

ofDoubles

public DoubleUpDownCounterBuilder ofDoubles()

Description copied from interface: LongUpDownCounterBuilder

Sets the Counter for recording double values.

Specified by:

ofDoubles in interface LongUpDownCounterBuilder

buildWithCallback

public ObservableLongUpDownCounter buildWithCallback(java.util.function.Consumer<ObservableLongMeasurement> callback)

Description copied from interface: LongUpDownCounterBuilder

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.

Specified by:

buildWithCallback in interface LongUpDownCounterBuilder

Parameters:

callback - A callback which observes measurements when invoked.

buildObserver

public ObservableLongMeasurement buildObserver()

Description copied from interface: LongUpDownCounterBuilder

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 LongUpDownCounterBuilder

Returns:

an observable measurement that batch callbacks use to observe values.

setAttributesAdvice

public ExtendedLongUpDownCounterBuilder setAttributesAdvice(java.util.List<AttributeKey<?>> attributes)

Description copied from interface: ExtendedLongUpDownCounterBuilder

Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this up down counter.

Specified by:

setAttributesAdvice in interface ExtendedLongUpDownCounterBuilder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object