io.opentelemetry.metrics

Interface Instrument.Builder

All Known Subinterfaces:

AsynchronousInstrument.Builder, DoubleCounter.Builder, DoubleSumObserver.Builder, DoubleUpDownCounter.Builder, DoubleUpDownSumObserver.Builder, DoubleValueObserver.Builder, DoubleValueRecorder.Builder, LongCounter.Builder, LongSumObserver.Builder, LongUpDownCounter.Builder, LongUpDownSumObserver.Builder, LongValueObserver.Builder, LongValueRecorder.Builder, SynchronousInstrument.Builder

Enclosing interface:

Instrument

public static interface Instrument.Builder

The Builder class for the Instrument.

Method Summary

Modifier and Type	Method and Description
Instrument	build() Builds and returns a Instrument with the desired options.
Instrument.Builder	setConstantLabels(Labels constantLabels) Sets the map of constant labels (they will be added to all the Bound Instruments) for the Instrument.
Instrument.Builder	setDescription(String description) Sets the description of the Instrument.
Instrument.Builder	setUnit(String unit) Sets the unit of the Instrument.

Method Detail

setDescription

Instrument.Builder setDescription(String description)

Sets the description of the Instrument.

Default value is "".

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

Instrument.Builder setUnit(String unit)

Sets the unit of the Instrument.

Default value is "1".

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setConstantLabels

Instrument.Builder setConstantLabels(Labels constantLabels)

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

Default value is Collections.emptyMap().

Parameters:

constantLabels - the map of constant labels for the Instrument.

Returns:

this.

build

Instrument build()

Builds and returns a Instrument with the desired options.

Returns:

a Instrument with the desired options.