Package io.opentelemetry.api.metrics

Interface LongValueObserver.Builder

All Superinterfaces:

AsynchronousInstrument.Builder<AsynchronousInstrument.LongResult>, Instrument.Builder

Enclosing interface:

LongValueObserver

public static interface LongValueObserver.Builder
extends AsynchronousInstrument.Builder<AsynchronousInstrument.LongResult>

Builder class for LongValueObserver.

Method Summary

Modifier and Type	Method	Description
LongValueObserver	build()	Builds and returns a Instrument with the desired options.
LongValueObserver.Builder	setCallback(AsynchronousInstrument.Callback<AsynchronousInstrument.LongResult> callback)	Sets a callback that gets executed every collection interval.
LongValueObserver.Builder	setDescription(java.lang.String description)	Sets the description of the Instrument.
LongValueObserver.Builder	setUnit(java.lang.String unit)	Sets the unit of the Instrument.

Method Detail

setDescription

LongValueObserver.Builder setDescription(java.lang.String description)

Description copied from interface: Instrument.Builder

Sets the description of the Instrument.

Default value is "".

Specified by:

setDescription in interface Instrument.Builder

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

LongValueObserver.Builder setUnit(java.lang.String unit)

Description copied from interface: Instrument.Builder

Sets the unit of the Instrument.

Default value is "1".

Specified by:

setUnit in interface Instrument.Builder

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setCallback

LongValueObserver.Builder setCallback(AsynchronousInstrument.Callback<AsynchronousInstrument.LongResult> callback)

Description copied from interface: AsynchronousInstrument.Builder

Sets a callback 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:

setCallback in interface AsynchronousInstrument.Builder<AsynchronousInstrument.LongResult>

Parameters:

callback - the callback to be executed before export.

build

LongValueObserver build()

Description copied from interface: Instrument.Builder

Builds and returns a Instrument with the desired options.

Specified by:

build in interface AsynchronousInstrument.Builder<AsynchronousInstrument.LongResult>

Specified by:

build in interface Instrument.Builder

Returns:

a Instrument with the desired options.