Package io.opentelemetry.api.metrics

Interface LongValueObserverBuilder

All Superinterfaces:

AsynchronousInstrumentBuilder<AsynchronousInstrument.LongResult>, InstrumentBuilder

public interface LongValueObserverBuilder
extends AsynchronousInstrumentBuilder<AsynchronousInstrument.LongResult>

Builder class for LongValueObserver.

Method Summary

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

Method Detail

setDescription

LongValueObserverBuilder 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

LongValueObserverBuilder 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

LongValueObserverBuilder setUpdater(Consumer<AsynchronousInstrument.LongResult> 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.LongResult>

Parameters:

updater - the consumer to be executed before export.

build

LongValueObserver build()

Description copied from interface: InstrumentBuilder

Builds and returns a Instrument with the desired options.

Specified by:

build in interface AsynchronousInstrumentBuilder<AsynchronousInstrument.LongResult>

Specified by:

build in interface InstrumentBuilder

Returns:

a Instrument with the desired options.