Package io.opentelemetry.api.metrics

Interface DoubleValueObserverBuilder

All Superinterfaces:

AsynchronousInstrumentBuilder<AsynchronousInstrument.DoubleResult>, InstrumentBuilder

public interface DoubleValueObserverBuilder
extends AsynchronousInstrumentBuilder<AsynchronousInstrument.DoubleResult>

Builder class for DoubleValueObserver.

Method Summary

Modifier and Type	Method	Description
DoubleValueObserver	build()	Builds and returns a Instrument with the desired options.
DoubleValueObserverBuilder	setDescription(String description)	Sets the description of the Instrument.
DoubleValueObserverBuilder	setUnit(String unit)	Sets the unit of the Instrument.
DoubleValueObserverBuilder	setUpdater(Consumer<AsynchronousInstrument.DoubleResult> updater)	Sets a consumer that gets executed every collection interval.

Method Detail

setDescription

DoubleValueObserverBuilder setDescription(String description)

Description copied from interface: InstrumentBuilder

Sets the description of the Instrument.

Default value is "".

Specified by:

setDescription in interface InstrumentBuilder

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

DoubleValueObserverBuilder setUnit(String unit)

Description copied from interface: InstrumentBuilder

Sets the unit of the Instrument.

Default value is "1".

Specified by:

setUnit in interface InstrumentBuilder

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setUpdater

DoubleValueObserverBuilder setUpdater(Consumer<AsynchronousInstrument.DoubleResult> updater)

Description copied from interface: AsynchronousInstrumentBuilder

Sets a consumer that gets executed every collection interval.

Evaluation is deferred until needed, if this AsynchronousInstrument metric is not exported then it will never be called.

Specified by:

setUpdater in interface AsynchronousInstrumentBuilder<AsynchronousInstrument.DoubleResult>

Parameters:

updater - the consumer to be executed before export.

build

DoubleValueObserver build()

Description copied from interface: InstrumentBuilder

Builds and returns a Instrument with the desired options.

Specified by:

build in interface AsynchronousInstrumentBuilder<AsynchronousInstrument.DoubleResult>

Specified by:

build in interface InstrumentBuilder

Returns:

a Instrument with the desired options.