io.opentelemetry.metrics

Interface DoubleCounter.Builder

All Superinterfaces:

Counter.Builder, Instrument.Builder

Enclosing interface:

DoubleCounter

public static interface DoubleCounter.Builder
extends Counter.Builder

Builder class for DoubleCounter.

Method Summary

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

Method Detail

setDescription

DoubleCounter.Builder setDescription(String description)

Description copied from interface: Instrument.Builder

Sets the description of the Instrument.

Default value is "".

Specified by:

setDescription in interface Counter.Builder

Specified by:

setDescription in interface Instrument.Builder

Parameters:

description - the description of the Instrument.

Returns:

this.

setUnit

DoubleCounter.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 Counter.Builder

Specified by:

setUnit in interface Instrument.Builder

Parameters:

unit - the unit of the Instrument.

Returns:

this.

setLabelKeys

DoubleCounter.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 Counter.Builder

Specified by:

setLabelKeys in interface Instrument.Builder

Parameters:

labelKeys - the list of label keys for the Instrument.

Returns:

this.

setConstantLabels

DoubleCounter.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 Counter.Builder

Specified by:

setConstantLabels in interface Instrument.Builder

Parameters:

constantLabels - the map of constant labels for the Instrument.

Returns:

this.

setMonotonic

DoubleCounter.Builder setMonotonic(boolean monotonic)

Description copied from interface: Counter.Builder

Sets the monotonicity property for this Counter. If true only non-negative values are expected.

Default value is true

Specified by:

setMonotonic in interface Counter.Builder

Parameters:

monotonic - true only positive values are expected.

Returns:

this.

build

DoubleCounter build()

Description copied from interface: Instrument.Builder

Builds and returns a Instrument with the desired options.

Specified by:

build in interface Counter.Builder

Specified by:

build in interface Instrument.Builder

Returns:

a Instrument with the desired options.