Struct PeriodicReader

pub struct PeriodicReader { /* private fields */ }

A MetricReader that continuously collects and exports metric data at a set interval.

By default it will collect and export data every 60 seconds, and will cancel export attempts that exceed 30 seconds. The export time is not counted towards the interval between attempts.

The collect method of the returned continues to gather and return metric data to the user. It will not automatically send that data to the exporter outside of the predefined interval.

The runtime can be selected based on feature flags set for this crate.

The exporter can be any exporter that implements PushMetricExporter such as opentelemetry-otlp.

Example

use opentelemetry_sdk::metrics::PeriodicReader;

let exporter = get_exporter(); // set up a push exporter like OTLP
let runtime = get_runtime(); // select runtime: e.g. opentelemetry_sdk:runtime::Tokio

let reader = PeriodicReader::builder(exporter, runtime).build();

Implementations

impl PeriodicReader

pub fn builder<E, RT>(exporter: E, runtime: RT) -> PeriodicReaderBuilder<E, RT>

where E: PushMetricExporter, RT: Runtime,

Configuration options for a periodic reader

Trait Implementations

impl Clone for PeriodicReader

fn clone(&self) -> PeriodicReader

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PeriodicReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MetricReader for PeriodicReader

fn temporality(&self, kind: InstrumentKind) -> Temporality

To construct a MetricReader when setting up an SDK, The output temporality (optional), a function of instrument kind. This function SHOULD be obtained from the exporter.

If not configured, the Cumulative temporality SHOULD be used.

fn register_pipeline(&self, pipeline: Weak<Pipeline>)

Registers a MetricReader with a [Pipeline].

fn collect(&self, rm: &mut ResourceMetrics) -> MetricResult<()>

Gathers and returns all metric data related to the MetricReader from the SDK and stores it in the provided ResourceMetrics reference.

fn force_flush(&self) -> MetricResult<()>

Flushes all metric measurements held in an export pipeline.

fn shutdown(&self) -> MetricResult<()>

Flushes all metric measurements held in an export pipeline and releases any held computational resources.