Struct opentelemetry::sdk::metrics::controllers::BasicController

pub struct BasicController(_);

Available on crate feature metrics only.

Organizes and synchronizes collection of metric data in both “pull” and “push” configurations.

This supports two distinct modes:

• Push and Pull: start must be called to begin calling the exporter; collect is called periodically after starting the controller.
• Pull-Only: start is optional in this case, to call collect periodically. If start is not called, collect can be called manually to initiate collection.

The controller supports mixing push and pull access to metric data using the InstrumentationLibraryReader interface.

Implementations

impl BasicController

pub fn start<T>(&self, cx: &Context, rt: T) -> Result<(), MetricsError>where
    T: Runtime,

This begins a ticker that periodically collects and exports metrics with the configured interval.

This is required for calling a configured MetricsExporter (see BasicControllerBuilder::with_exporter) and is otherwise optional when only pulling metric data.

The passed in context is passed to collect and subsequently to asynchronous instrument callbacks. Returns an error when the controller was already started.

Note that it is not necessary to start a controller when only pulling data; use the collect and try_for_each methods directly in this case.

pub fn stop(&self, cx: &Context) -> Result<(), MetricsError>

This waits for the background worker to return and then collects and exports metrics one last time before returning.

The passed context is passed to the final collect and subsequently to the final asynchronous instruments.

Note that stop will not cancel an ongoing collection or export.

pub fn is_running(&self) -> bool

true if the controller was started via start, indicating that the current Reader is being kept up-to-date.

pub fn collect(&self, cx: &Context) -> Result<(), MetricsError>

Requests a collection.

The collection will be skipped if the last collection is aged less than the configured collection period.

pub fn resource(&self) -> &Resource

Get a reference to the current resource.

Trait Implementations

impl Clone for BasicController

fn clone(&self) -> BasicController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicController

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

Formats the value using the given formatter.

impl InstrumentationLibraryReader for BasicController

fn try_for_each(
    &self,
    f: &mut dyn FnMut(&InstrumentationLibrary, &mut dyn Reader)
) -> Result<(), MetricsError>

ForEach calls the passed function once per instrumentation library, allowing the caller to emit metrics grouped by the library that produced them.

impl MeterProvider for BasicController

fn versioned_meter(
    &self,
    name: &'static str,
    version: Option<&'static str>,
    schema_url: Option<&'static str>
) -> Meter

Creates an implementation of the Meter interface.

fn meter(&self, name: &'static str) -> Meter

Creates a named Meter instance.