Struct SimpleMetricManager

pub struct SimpleMetricManager<H> { /* private fields */ }

A MetricManager implementation that provides simple metric registration and handling.

SimpleMetricManager provides a simple way to manage metrics with support for command callbacks and metric publishing.

Example

use srad_eon::SimpleMetricManager;

//Create a new simple metric manager
let manager = SimpleMetricManager::new();

// Assume we successfully create a device with a SimpleMetricManager as it's metrics manager
create_device_with_manager(&manager);

// Register a simple metric
let counter = manager.register_metric("Counter", 0 as i32).unwrap();

// Register a metric with a command handler
let temperature = manager.register_metric_with_cmd_handler(
    "temperature",
    25.5,
    |mgr, metric, new_value| async move {
        if let Some(value) = new_value {
          mgr.publish_metric(metric.update(|x|{ *x = value })).await;
        }
    }
);

Implementations

impl<H> SimpleMetricManager<H>

where H: MetricPublisher + Clone + Send + Sync + 'static,

pub fn new() -> Self

Creates a new empty SimpleMetricManager.

This initialises a new metric manager with no registered metrics.

pub fn register_metric<S, T>( &self, name: S, value: T, ) -> Option<SimpleManagerMetric<T, H>>

where S: Into<String>, T: MetricValue + Clone + Send + 'static,

Registers a new metric with the given name and initial value.

Returns None if a metric with the same name already exists, otherwise returns the newly created metric.

pub fn register_metric_with_cmd_handler<S, T, F, Fut>( &self, name: S, value: T, cmd_handler: F, ) -> Option<SimpleManagerMetric<T, H>>

where S: Into<String>, T: MetricValue + Clone + Send + 'static, F: Fn(SimpleMetricManager<H>, SimpleManagerMetric<T, H>, Option<T>) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Registers a new metric with a command handler that will be called when commands for this metric are received.

The command handler is an async function that receives the manager, the metric, and an optional new value for the metric. If the value is “None” that indicates the CMD metric ‘is_null’ field was true

Returns None if a metric with the same name already exists, otherwise returns the newly created metric.

pub async fn publish_metric( &self, metric: SimpleManagerPublishMetric, ) -> Result<(), PublishError>

Publishes a single metric.

Returns an error if the metric was not published.

pub async fn publish_metrics( &self, metrics: Vec<SimpleManagerPublishMetric>, ) -> Result<(), PublishError>

Publishes a multiple metric in a single batch.

Returns an error if the metrics were not published.

Trait Implementations

impl<H: Clone> Clone for SimpleMetricManager<H>

fn clone(&self) -> SimpleMetricManager<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H> Default for SimpleMetricManager<H>

where H: MetricPublisher + Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl DeviceMetricManager for SimpleMetricManager<DeviceHandle>

fn init(&self, handle: &DeviceHandle)

Initialise the struct.

fn on_dcmd<'life0, 'async_trait>( &'life0 self, __arg1: DeviceHandle, metrics: MessageMetrics, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Processes DCMD metrics.

impl<H> MetricManager for SimpleMetricManager<H>

fn initialise_birth(&self, bi: &mut BirthInitializer)

Initialises the set of metrics to be included in a birth or rebirth message.

impl NodeMetricManager for SimpleMetricManager<NodeHandle>

fn init(&self, handle: &NodeHandle)

Initialise the struct.

fn on_ncmd<'life0, 'async_trait>( &'life0 self, __arg1: NodeHandle, metrics: MessageMetrics, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Processes NCMD metrics.