axcp-sdk 0.3.11-beta

Rust client SDK for AXCP protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Telemetry functionality for the AXCP SDK.

use crate::client::Client;
use crate::error::Result;
use crate::models::TelemetryData;
use std::collections::HashMap;
use std::time::{SystemTime, UNIX_EPOCH};

/// A builder for creating telemetry data points.
#[derive(Debug, Default)]
pub struct TelemetryBuilder {
    metric: String,
    value: f64,
    tags: HashMap<String, String>,
    timestamp: Option<i64>,
}

impl TelemetryBuilder {
    /// Creates a new telemetry builder with the given metric name and value.
    pub fn new(metric: impl Into<String>, value: f64) -> Self {
        Self {
            metric: metric.into(),
            value,
            ..Default::default()
        }
    }

    /// Adds a tag to the telemetry data.
    pub fn with_tag(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.tags.insert(key.into(), value.into());
        self
    }

    /// Sets the timestamp of the telemetry data.
    pub fn with_timestamp(mut self, timestamp: i64) -> Self {
        self.timestamp = Some(timestamp);
        self
    }

    /// Builds the telemetry data point.
    pub fn build(self) -> TelemetryData {
        TelemetryData {
            metric: self.metric,
            value: self.value,
            tags: self.tags,
            timestamp: self.timestamp.or_else(|| {
                SystemTime::now()
                    .duration_since(UNIX_EPOCH)
                    .ok()
                    .map(|d| d.as_millis() as i64)
            }),
        }
    }
}

/// A telemetry client for recording metrics.
#[derive(Debug, Clone)]
pub struct TelemetryClient {
    client: Client,
}

impl TelemetryClient {
    /// Creates a new telemetry client.
    pub fn new(client: Client) -> Self {
        Self { client }
    }

    /// Records a metric with the given name and value.
    pub async fn record_metric(
        &self,
        metric: impl Into<String>,
        value: f64,
    ) -> Result<()> {
        let data = TelemetryBuilder::new(metric, value).build();
        self.client.telemetry().record(data).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_telemetry_builder() {
        let data = TelemetryBuilder::new("test.metric", 42.0)
            .with_tag("tag1", "value1")
            .with_tag("tag2", "value2")
            .with_timestamp(1234567890)
            .build();

        assert_eq!(data.metric, "test.metric");
        assert_eq!(data.value, 42.0);
        assert_eq!(data.tags.get("tag1"), Some(&"value1".to_string()));
        assert_eq!(data.tags.get("tag2"), Some(&"value2".to_string()));
        assert_eq!(data.timestamp, Some(1234567890));
    }
}