Package io.opentelemetry.api.metrics

Interface BatchRecorder

@ThreadSafe
public interface BatchRecorder

Util class that can be use to atomically record measurements associated with a set of Metrics.

This class is equivalent with individually calling record on every Measure, but has the advantage that all these operations are recorded atomically and it is more efficient.

Method Summary

Modifier and Type	Method	Description
BatchRecorder	put(DoubleCounter counter, double value)	Associates the DoubleCounter with the given value.
BatchRecorder	put(DoubleUpDownCounter upDownCounter, double value)	Associates the DoubleUpDownCounter with the given value.
BatchRecorder	put(DoubleValueRecorder valueRecorder, double value)	Associates the DoubleValueRecorder with the given value.
BatchRecorder	put(LongCounter counter, long value)	Associates the LongCounter with the given value.
BatchRecorder	put(LongUpDownCounter upDownCounter, long value)	Associates the LongUpDownCounter with the given value.
BatchRecorder	put(LongValueRecorder valueRecorder, long value)	Associates the LongValueRecorder with the given value.
void	record()	Records all of measurements at the same time.

Method Detail

put

BatchRecorder put(LongValueRecorder valueRecorder,
                  long value)

Associates the LongValueRecorder with the given value. Subsequent updates to the same LongValueRecorder will overwrite the previous value.

Parameters:

valueRecorder - the LongValueRecorder.

value - the value to be associated with valueRecorder.

Returns:

this.

put

BatchRecorder put(DoubleValueRecorder valueRecorder,
                  double value)

Associates the DoubleValueRecorder with the given value. Subsequent updates to the same DoubleValueRecorder will overwrite the previous value.

Parameters:

valueRecorder - the DoubleValueRecorder.

value - the value to be associated with valueRecorder.

Returns:

this.

put

BatchRecorder put(LongCounter counter,
                  long value)

Associates the LongCounter with the given value. Subsequent updates to the same LongCounter will overwrite the previous value.

Parameters:

counter - the LongCounter.

value - the value to be associated with counter.

Returns:

this.

put

BatchRecorder put(DoubleCounter counter,
                  double value)

Associates the DoubleCounter with the given value. Subsequent updates to the same DoubleCounter will overwrite the previous value.

Parameters:

counter - the DoubleCounter.

value - the value to be associated with counter.

Returns:

this.

put

BatchRecorder put(LongUpDownCounter upDownCounter,
                  long value)

Associates the LongUpDownCounter with the given value. Subsequent updates to the same LongCounter will overwrite the previous value.

Parameters:

upDownCounter - the LongCounter.

value - the value to be associated with counter.

Returns:

this.

put

BatchRecorder put(DoubleUpDownCounter upDownCounter,
                  double value)

Associates the DoubleUpDownCounter with the given value. Subsequent updates to the same DoubleCounter will overwrite the previous value.

Parameters:

upDownCounter - the DoubleCounter.

value - the value to be associated with counter.

Returns:

this.

record

void record()

Records all of measurements at the same time.

This method records all measurements every time it is called, so make sure it is not called twice if not needed.