io.opentelemetry.metrics

Interface LongMeasure.Builder

All Superinterfaces:

Instrument.Builder, Measure.Builder

Enclosing interface:

LongMeasure

public static interface LongMeasure.Builder
extends Measure.Builder

Builder class for LongMeasure.

Method Summary

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

Method Detail

setDescription

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

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

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

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setLabelKeys

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

Parameters:

labelKeys - the list of label keys for the Instrument.

Returns:

this.

setConstantLabels

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

Parameters:

constantLabels - the map of constant labels for the Instrument.

Returns:

this.

setAbsolute

LongMeasure.Builder setAbsolute(boolean absolute)

Description copied from interface: Measure.Builder

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

Default value is true

Specified by:

setAbsolute in interface Measure.Builder

Parameters:

absolute - true only positive values are expected.

Returns:

this.

build

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

Returns:

a Instrument with the desired options.