io.opentelemetry.metrics

Interface Measure.Builder

All Superinterfaces:

Instrument.Builder

All Known Subinterfaces:

DoubleMeasure.Builder, LongMeasure.Builder

Enclosing interface:

Measure<H extends InstrumentWithBinding.BoundInstrument>

public static interface Measure.Builder
extends Instrument.Builder

Builder class for Measure.

Method Summary

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

Method Detail

setDescription

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

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

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

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

setAbsolute

Measure.Builder setAbsolute(boolean absolute)

Sets the absolute property for this Builder. If true only positive values are expected.

Default value is true

Parameters:

absolute - true only positive values are expected.

Returns:

this.

build

Measure<?> 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.