io.opentelemetry.metrics

Interface Observer.Builder

All Superinterfaces:

Instrument.Builder

All Known Subinterfaces:

DoubleObserver.Builder, LongObserver.Builder

Enclosing interface:

Observer<R>

public static interface Observer.Builder
extends Instrument.Builder

Builder class for Observer.

Method Summary

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

Method Detail

setDescription

Observer.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

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

Observer.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

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setLabelKeys

Observer.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

Parameters:

labelKeys - the list of label keys for the Instrument.

Returns:

this.

setConstantLabels

Observer.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

Parameters:

constantLabels - the map of constant labels for the Instrument.

Returns:

this.

setMonotonic

Observer.Builder setMonotonic(boolean monotonic)

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

Default value is false

Parameters:

monotonic - true successive values are expected to rise monotonically.

Returns:

this.

build

Observer<?> build()

Description copied from interface: Instrument.Builder

Builds and returns a Instrument with the desired options.

Specified by:

build in interface Instrument.Builder

Returns:

a Instrument with the desired options.