Class DefaultMeter.NoopLongUpDownCounterBuilder

java.lang.Object

io.opentelemetry.api.metrics.DefaultMeter.NoopLongUpDownCounterBuilder

All Implemented Interfaces:

LongUpDownCounterBuilder

Enclosing class:

DefaultMeter

private static class DefaultMeter.NoopLongUpDownCounterBuilder
extends Object
implements LongUpDownCounterBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private static final DoubleUpDownCounterBuilder	NOOP_DOUBLE_UP_DOWN_COUNTER_BUILDER
private static final ObservableLongUpDownCounter	NOOP_OBSERVABLE_UP_DOWN_COUNTER
private static final LongUpDownCounter	NOOP_UP_DOWN_COUNTER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopLongUpDownCounterBuilder()

Method Summary

Modifier and Type	Method	Description
LongUpDownCounter	build()	Builds and returns an UpDownCounter instrument with the configuration.
ObservableLongMeasurement	buildObserver()	Build an observer for this instrument to observe values from a BatchCallback.
ObservableLongUpDownCounter	buildWithCallback(Consumer<ObservableLongMeasurement> callback)	Builds an Asynchronous UpDownCounter instrument with the given callback.
DoubleUpDownCounterBuilder	ofDoubles()	Sets the Counter for recording double values.
LongUpDownCounterBuilder	setDescription(String description)	Sets the description for this instrument.
LongUpDownCounterBuilder	setUnit(String unit)	Sets the unit of measure for this instrument.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NOOP_UP_DOWN_COUNTER

private static final LongUpDownCounter NOOP_UP_DOWN_COUNTER

NOOP_OBSERVABLE_UP_DOWN_COUNTER

private static final ObservableLongUpDownCounter NOOP_OBSERVABLE_UP_DOWN_COUNTER

NOOP_DOUBLE_UP_DOWN_COUNTER_BUILDER

private static final DoubleUpDownCounterBuilder NOOP_DOUBLE_UP_DOWN_COUNTER_BUILDER

Constructor Details

NoopLongUpDownCounterBuilder

private NoopLongUpDownCounterBuilder()

Method Details

setDescription

public LongUpDownCounterBuilder setDescription(String description)

Description copied from interface: LongUpDownCounterBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface LongUpDownCounterBuilder

Parameters:

description - The description.

See Also:

• Instrument Description

setUnit

public LongUpDownCounterBuilder setUnit(String unit)

Description copied from interface: LongUpDownCounterBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface LongUpDownCounterBuilder

Parameters:

unit - The unit. Instrument units must be 63 or fewer ASCII characters.

See Also:

• Instrument Unit

ofDoubles

public DoubleUpDownCounterBuilder ofDoubles()

Description copied from interface: LongUpDownCounterBuilder

Sets the Counter for recording double values.

Specified by:

ofDoubles in interface LongUpDownCounterBuilder

build

public LongUpDownCounter build()

Description copied from interface: LongUpDownCounterBuilder

Builds and returns an UpDownCounter instrument with the configuration.

Specified by:

build in interface LongUpDownCounterBuilder

Returns:

The UpDownCounter instrument.

buildWithCallback

public ObservableLongUpDownCounter buildWithCallback(Consumer<ObservableLongMeasurement> callback)

Description copied from interface: LongUpDownCounterBuilder

Builds an Asynchronous UpDownCounter instrument with the given callback.

The callback will be called when the instrument is being observed.

Callbacks are expected to abide by the following restrictions:

• Run in a finite amount of time.
• Safe to call repeatedly, across multiple threads.

Specified by:

buildWithCallback in interface LongUpDownCounterBuilder

Parameters:

callback - A callback which observes measurements when invoked.

buildObserver

public ObservableLongMeasurement buildObserver()

Description copied from interface: LongUpDownCounterBuilder

Build an observer for this instrument to observe values from a BatchCallback.

This observer MUST be registered when creating a batchCallback, which records to it. Values observed outside registered callbacks are ignored.

Specified by:

buildObserver in interface LongUpDownCounterBuilder

Returns:

an observable measurement that batch callbacks use to observe values.