Class ExtendedDefaultMeter.NoopDoubleCounterBuilder

java.lang.Object

io.opentelemetry.api.incubator.metrics.ExtendedDefaultMeter.NoopDoubleCounterBuilder

All Implemented Interfaces:

ExtendedDoubleCounterBuilder, DoubleCounterBuilder

Enclosing class:

ExtendedDefaultMeter

private static class ExtendedDefaultMeter.NoopDoubleCounterBuilder
extends Object
implements ExtendedDoubleCounterBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private static final DoubleCounter	NOOP_COUNTER
private static final ObservableDoubleCounter	NOOP_OBSERVABLE_COUNTER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopDoubleCounterBuilder()

Method Summary

Modifier and Type	Method	Description
DoubleCounter	build()	Builds and returns a Counter instrument with the configuration.
ObservableDoubleMeasurement	buildObserver()	Build an observer for this instrument to observe values from a BatchCallback.
ObservableDoubleCounter	buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)	Builds an Asynchronous Counter instrument with the given callback.
DoubleCounterBuilder	setDescription(String description)	Sets the description for this instrument.
DoubleCounterBuilder	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

Methods inherited from interface ExtendedDoubleCounterBuilder

setAttributesAdvice

Field Details

NOOP_COUNTER

private static final DoubleCounter NOOP_COUNTER

NOOP_OBSERVABLE_COUNTER

private static final ObservableDoubleCounter NOOP_OBSERVABLE_COUNTER

Constructor Details

NoopDoubleCounterBuilder

private NoopDoubleCounterBuilder()

Method Details

setDescription

public DoubleCounterBuilder setDescription(String description)

Description copied from interface: DoubleCounterBuilder

Sets the description for this instrument.

Specified by:

setDescription in interface DoubleCounterBuilder

Parameters:

description - The description.

See Also:

• Instrument Description

setUnit

public DoubleCounterBuilder setUnit(String unit)

Description copied from interface: DoubleCounterBuilder

Sets the unit of measure for this instrument.

Specified by:

setUnit in interface DoubleCounterBuilder

Parameters:

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

See Also:

• Instrument Unit

build

public DoubleCounter build()

Description copied from interface: DoubleCounterBuilder

Builds and returns a Counter instrument with the configuration.

Specified by:

build in interface DoubleCounterBuilder

Returns:

The Counter instrument.

buildWithCallback

public ObservableDoubleCounter buildWithCallback(Consumer<ObservableDoubleMeasurement> callback)

Description copied from interface: DoubleCounterBuilder

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 DoubleCounterBuilder

Parameters:

callback - A callback which observes measurements when invoked.

buildObserver

public ObservableDoubleMeasurement buildObserver()

Description copied from interface: DoubleCounterBuilder

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 DoubleCounterBuilder

Returns:

an observable measurement that batch callbacks use to observe values.