CollectionRegistration (OpenTelemetry SDK Metrics)

public interface CollectionRegistration

A CollectionRegistration is passed to each MetricReader registered with SdkMeterProvider, and provides readers the ability to trigger metric collections.

Since:: 1.14.0

Method Summary

Modifier and Type

Method

Description

default Collection<MetricData>

collectAllMetrics()

Collect all metrics, including metrics from the SDK and any registered MetricProducers.

static CollectionRegistration

noop()

Returns a noop CollectionRegistration, useful for MetricReaders to hold before MetricReader.register(CollectionRegistration) is called.

Method Details
- noop
  
  static CollectionRegistration noop()
  
  Returns a noop CollectionRegistration, useful for MetricReaders to hold before MetricReader.register(CollectionRegistration) is called.
  
  Since:
  
  1.31.0
- collectAllMetrics
  
  default Collection<MetricData> collectAllMetrics()
  
  Collect all metrics, including metrics from the SDK and any registered MetricProducers.
  If MetricReader.getMemoryMode() is configured to MemoryMode.REUSABLE_DATA do not keep the result or any of its contained objects as they are to be reused to return the result for the next call to this method.
  
  Since:
  
  1.31.0