Struct opentelemetry_sdk::metrics::MeterProvider

pub struct MeterProvider { /* private fields */ }

Handles the creation and coordination of Meters.

All Meters created by a MeterProvider will be associated with the same Resource, have the same Views applied to them, and have their produced metric telemetry passed to the configured MetricReaders.

Implementations

impl MeterProvider

pub fn builder() -> MeterProviderBuilder

Flushes all pending telemetry.

There is no guaranteed that all telemetry be flushed or all resources have been released on error.

pub fn force_flush(&self) -> Result<()>

Flushes all pending telemetry.

There is no guaranteed that all telemetry be flushed or all resources have been released on error.

Examples

use opentelemetry::{global, Context};
use opentelemetry_sdk::metrics::MeterProvider;

fn init_metrics() -> MeterProvider {
    let provider = MeterProvider::default();

    // Set provider to be used as global meter provider
    let _ = global::set_meter_provider(provider.clone());

    // Setup metric pipelines with readers + views

    provider
}

fn main() {
    let provider = init_metrics();

    // create instruments + record measurements

    // force all instruments to flush
    provider.force_flush().unwrap();

    // record more measurements..

    // dropping provider and shutting down global provider ensure all
    // remaining metrics data are exported
    drop(provider);
    global::shutdown_meter_provider();
}

pub fn shutdown(&self) -> Result<()>

Shuts down the meter provider flushing all pending telemetry and releasing any held computational resources.

This call is idempotent. The first call will perform all flush and releasing operations. Subsequent calls will perform no action and will return an error stating this.

Measurements made by instruments from meters this MeterProvider created will not be exported after Shutdown is called.

There is no guaranteed that all telemetry be flushed or all resources have been released on error.

Trait Implementations

impl Clone for MeterProvider

fn clone(&self) -> MeterProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MeterProvider

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

Formats the value using the given formatter.

impl Default for MeterProvider

fn default() -> Self

Returns the “default value” for a type.

impl MeterProvider for MeterProvider

fn versioned_meter( &self, name: impl Into<Cow<'static, str>>, version: Option<impl Into<Cow<'static, str>>>, schema_url: Option<impl Into<Cow<'static, str>>>, attributes: Option<Vec<KeyValue>>, ) -> ApiMeter

Returns a new versioned meter with a given name.

fn meter(&self, name: impl Into<Cow<'static, str>>) -> Meter

Returns a new Meter with the provided name and default configuration.