io.opentelemetry.metrics

Interface Counter.Builder

All Superinterfaces:

Instrument.Builder

All Known Subinterfaces:

DoubleCounter.Builder, LongCounter.Builder

Enclosing interface:

Counter<H extends InstrumentWithBinding.BoundInstrument>

public static interface Counter.Builder
extends Instrument.Builder

Builder class for Counter.

Method Summary

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

Method Detail

setDescription

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

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

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

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

Counter.Builder setMonotonic(boolean monotonic)

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

Default value is true

Parameters:

monotonic - true only positive values are expected.

Returns:

this.

build

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