Top Description Methods
io.opentelemetry.api.metrics

public Interface LongCounterBuilder

Known Direct Implementers
io.opentelemetry.api.metrics.DefaultMeter.NoopLongCounterBuilder
Imports
java.util.function.Consumer

Builder class for LongCounter.
Since
1.10.0

Method Summary

Modifier and TypeMethod and Description
public LongCounter

Returns:

The Counter instrument.
build
()

Builds and returns a Counter instrument with the configuration.

public default ObservableLongMeasurement

Returns:

an observable measurement that batch callbacks use to observe values.
buildObserver
()

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

public ObservableLongCounter
buildWithCallback(Consumer<ObservableLongMeasurement>
A callback which observes measurements when invoked.
callback
)

Builds an Asynchronous Counter instrument with the given callback.

public DoubleCounterBuilder
ofDoubles()

Sets the Counter for recording double values.

public LongCounterBuilder
setDescription(String
The description.
description
)

Sets the description for this instrument.

public LongCounterBuilder
setUnit(String
The unit. Instrument units must be 63 or fewer ASCII characters.
unit
)

Sets the unit of measure for this instrument.

Method Detail

buildback to summary
public LongCounter build()

Builds and returns a Counter instrument with the configuration.

Returns:LongCounter

The Counter instrument.

buildObserverback to summary
public default ObservableLongMeasurement buildObserver()

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.

Returns:ObservableLongMeasurement

an observable measurement that batch callbacks use to observe values.

Since
1.15.0
buildWithCallbackback to summary
public ObservableLongCounter buildWithCallback(Consumer<ObservableLongMeasurement> callback)

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.
Parameters
callback:Consumer<ObservableLongMeasurement>

A callback which observes measurements when invoked.

ofDoublesback to summary
public DoubleCounterBuilder ofDoubles()

Sets the Counter for recording double values.

setDescriptionback to summary
public LongCounterBuilder setDescription(String description)

Sets the description for this instrument.

Parameters
description:String

The description.

See Also
Instrument Description
setUnitback to summary
public LongCounterBuilder setUnit(String unit)

Sets the unit of measure for this instrument.

Parameters
unit:String

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

See Also
Instrument Unit