Package io.opentelemetry.api.metrics

Class DefaultMeter.NoopLongCounterBuilder

java.lang.Object

io.opentelemetry.api.metrics.DefaultMeter.NoopLongCounterBuilder

All Implemented Interfaces:

LongCounterBuilder

Enclosing class:

DefaultMeter

private static class DefaultMeter.NoopLongCounterBuilder
extends Object
implements LongCounterBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private static final LongCounter	NOOP_COUNTER
private static final DoubleCounterBuilder	NOOP_DOUBLE_COUNTER_BUILDER
private static final ObservableLongCounter	NOOP_OBSERVABLE_COUNTER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopLongCounterBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

NOOP_COUNTER

private static final LongCounter NOOP_COUNTER

NOOP_OBSERVABLE_COUNTER

private static final ObservableLongCounter NOOP_OBSERVABLE_COUNTER

NOOP_DOUBLE_COUNTER_BUILDER

private static final DoubleCounterBuilder NOOP_DOUBLE_COUNTER_BUILDER

Constructor Details

NoopLongCounterBuilder

private NoopLongCounterBuilder()

Method Details

setDescription

public LongCounterBuilder setDescription(String description)

Description copied from interface: LongCounterBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface LongCounterBuilder

Parameters:

description - The description.

See Also:

• Instrument Description

setUnit

public LongCounterBuilder setUnit(String unit)

Description copied from interface: LongCounterBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface LongCounterBuilder

Parameters:

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

See Also:

• Instrument Unit

ofDoubles

public DoubleCounterBuilder ofDoubles()

Description copied from interface: LongCounterBuilder

Sets the Counter for recording double values.

Specified by:

ofDoubles in interface LongCounterBuilder

build

public LongCounter build()

Description copied from interface: LongCounterBuilder

Builds and returns a Counter instrument with the configuration.

Specified by:

build in interface LongCounterBuilder

Returns:

The Counter instrument.

buildWithCallback

public ObservableLongCounter buildWithCallback(Consumer<ObservableLongMeasurement> callback)

Description copied from interface: LongCounterBuilder

Builds an Asynchronous Counter 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 LongCounterBuilder

Parameters:

callback - A callback which observes measurements when invoked.

buildObserver

public ObservableLongMeasurement buildObserver()

Description copied from interface: LongCounterBuilder

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 LongCounterBuilder

Returns:

an observable measurement that batch callbacks use to observe values.