Package io.opentelemetry.api.metrics

Interface LongUpDownCounter

@ThreadSafe
public interface LongUpDownCounter

An UpDownCounter instrument that records long values.

Since:

1.10.0

Method Summary

Modifier and Type	Method	Description
void	add(long value)	Records a value.
void	add(long value, Attributes attributes)	Record a value with a set of attributes.
void	add(long value, Attributes attributes, io.opentelemetry.context.Context context)	Records a value with a set of attributes.
default boolean	isEnabled()	Returns true if the up down counter is enabled.

Method Details

isEnabled

default boolean isEnabled()

Returns true if the up down counter is enabled.

This allows callers to avoid unnecessary compute when nothing is consuming the data. Because the response is subject to change over the application, callers should call this before each call to add(long), add(long, Attributes), or add(long, Attributes, Context).

Since:

1.61.0

add

void add(long value)

Records a value.

Note: This may use Context.current() to pull the context associated with this measurement.

Parameters:

value - The increment amount. May be positive, negative or zero.

add

void add(long value,
 Attributes attributes)

Record a value with a set of attributes.

Note: This may use Context.current() to pull the context associated with this measurement.

Parameters:

value - The increment amount. May be positive, negative or zero.

attributes - A set of attributes to associate with the value.

add

void add(long value,
 Attributes attributes,
 io.opentelemetry.context.Context context)

Records a value with a set of attributes.

Parameters:

value - The increment amount. May be positive, negative or zero.

attributes - A set of attributes to associate with the value.

context - The explicit context to associate with this measurement.