io.opentelemetry.metrics

Interface LongObserver.Builder

All Superinterfaces:

Instrument.Builder, Observer.Builder

Enclosing interface:

LongObserver

public static interface LongObserver.Builder
extends Observer.Builder

Builder class for LongObserver.

Method Summary

Modifier and Type	Method and Description
LongObserver	build() Builds and returns a Instrument with the desired options.
LongObserver.Builder	setConstantLabels(Map<String,String> constantLabels) Sets the map of constant labels (they will be added to all the Bound Instruments) for the Instrument.
LongObserver.Builder	setDescription(String description) Sets the description of the Instrument.
LongObserver.Builder	setLabelKeys(List<String> labelKeys) Sets the list of label keys for the Instrument.
LongObserver.Builder	setMonotonic(boolean monotonic) Sets the monotonicity property for this Instrument.
LongObserver.Builder	setUnit(String unit) Sets the unit of the Instrument.

Method Detail

setDescription

LongObserver.Builder setDescription(String description)

Description copied from interface: Instrument.Builder

Sets the description of the Instrument.

Default value is "".

Specified by:

setDescription in interface Instrument.Builder

Specified by:

setDescription in interface Observer.Builder

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

LongObserver.Builder setUnit(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

Specified by:

setUnit in interface Observer.Builder

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setLabelKeys

LongObserver.Builder setLabelKeys(List<String> labelKeys)

Description copied from interface: Instrument.Builder

Sets the list of label keys for the Instrument.

Default value is Collections.emptyList()

Specified by:

setLabelKeys in interface Instrument.Builder

Specified by:

setLabelKeys in interface Observer.Builder

Parameters:

labelKeys - the list of label keys for the Instrument.

Returns:

this.

setConstantLabels

LongObserver.Builder setConstantLabels(Map<String,String> constantLabels)

Description copied from interface: Instrument.Builder

Sets the map of constant labels (they will be added to all the Bound Instruments) for the Instrument.

Default value is Collections.emptyMap().

Specified by:

setConstantLabels in interface Instrument.Builder

Specified by:

setConstantLabels in interface Observer.Builder

Parameters:

constantLabels - the map of constant labels for the Instrument.

Returns:

this.

setMonotonic

LongObserver.Builder setMonotonic(boolean monotonic)

Description copied from interface: Observer.Builder

Sets the monotonicity property for this Instrument. If true successive values are expected to rise monotonically.

Default value is false

Specified by:

setMonotonic in interface Observer.Builder

Parameters:

monotonic - true successive values are expected to rise monotonically.

Returns:

this.

build

LongObserver build()

Description copied from interface: Instrument.Builder

Builds and returns a Instrument with the desired options.

Specified by:

build in interface Instrument.Builder

Specified by:

build in interface Observer.Builder

Returns:

a Instrument with the desired options.