io.opentelemetry.metrics

Interface LongObserver

All Superinterfaces:

Instrument, Observer<LongObserver.ResultLongObserver>

@ThreadSafe
public interface LongObserver
extends Observer<LongObserver.ResultLongObserver>

Observer to report pre-aggregated metrics with double value.

Example:

 class YourClass {

   private static final Meter meter = OpenTelemetry.getMeterRegistry().get("my_library_name");
   private static final LongObserver observer =
       meter.
           .observerLongBuilder("doWork_latency")
           .setDescription("gRPC Latency")
           .setUnit("ms")
           .build();
   private static final LabelSet labelSet = meter.createLabelSet("my_label");

   void init() {
     observer.setCallback(
         new LongObserver.Callback<LongObserver.ResultLongObserver>() {
           final AtomicInteger count = new AtomicInteger(0);
          {@literal @}Override
           public void update(ResultLongObserver result) {
             result.observe(count.addAndGet(1), labelSet);
           }
         });
   }
 }
 

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LongObserver.Builder Builder class for LongObserver.
static interface	LongObserver.ResultLongObserver The result for the Observer.Callback.

Nested classes/interfaces inherited from interface io.opentelemetry.metrics.Observer

Observer.Callback<R>

Method Summary

Modifier and Type	Method and Description
void	setCallback(Observer.Callback<LongObserver.ResultLongObserver> metricUpdater) Sets a callback that gets executed every time before exporting this metric.

Method Detail

setCallback

void setCallback(Observer.Callback<LongObserver.ResultLongObserver> metricUpdater)

Description copied from interface: Observer

Sets a callback that gets executed every time before exporting this metric.

Evaluation is deferred until needed, if this Observer metric is not exported then it will never be called.

Specified by:

setCallback in interface Observer<LongObserver.ResultLongObserver>

Parameters:

metricUpdater - the callback to be executed before export.