Struct MetricsPusher

pub struct MetricsPusher { /* private fields */ }

Facilitates the push-style publishing of metrics.

When creating a push-mode event, you must provide an instance of MetricsPusher to the event builder. This instance is typically stored in a thread-local static variable.

On a regular basis, you must then call the push method on this instance to publish the metrics to a storage location where they can be included in reports.

Implementations

impl MetricsPusher

pub fn new() -> Self

Creates a new MetricsPusher instance.

Example

use nm::MetricsPusher;

thread_local! {
    static PUSHER: MetricsPusher = MetricsPusher::new();
}

pub fn push(&self)

Pushes the metrics to a storage location where they can be included in reports.

This method should be called periodically to ensure that push-model metrics are published.

Example

use nm::{Event, MetricsPusher, Push};

thread_local! {
    static PUSHER: MetricsPusher = MetricsPusher::new();

    static PUSH_EVENT: Event<Push> = Event::builder()
        .name("push_example")
        .pusher_local(&PUSHER)
        .build();
}

// Observe some events first
PUSH_EVENT.with(|e| e.observe_once());

// Periodically push the accumulated metrics
PUSHER.with(MetricsPusher::push);

Trait Implementations

impl Debug for MetricsPusher

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

Formats the value using the given formatter.

impl Default for MetricsPusher

fn default() -> Self

Returns the “default value” for a type.