carbon-core 0.12.0

Core library for Carbon
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! A trait for collecting and managing performance metrics within the pipeline.
//!
//! The `Metrics` trait defines a set of asynchronous methods for initializing,
//! updating, flushing, and shutting down metrics in the `carbon-core`
//! framework. This trait is designed for tracking various types of metrics,
//! such as counters, gauges, and histograms, to monitor performance and
//! operational health in real time.
//!
//! ## Key Concepts
//!
//! - **Gauges**: Track the value of a particular metric at a specific point in
//!   time. Useful for monitoring values that can fluctuate, like the number of
//!   queued updates.
//! - **Counters**: Track the number of times an event has occurred, such as
//!   successful or failed update processing.
//! - **Histograms**: Measure the distribution of values, such as processing
//!   times, allowing insights into latency or response times.
//!
//! ## Implementing the Trait
//!
//! To implement `Metrics`, provide implementations for each method, typically
//! sending metrics data to a monitoring system or backend service for
//! visualization and alerting. The trait requires `async` functions, allowing
//! implementations to perform non-blocking I/O operations, such as network
//! requests or database writes.

use {crate::error::CarbonResult, async_trait::async_trait, std::sync::Arc};

#[async_trait]
pub trait Metrics: Send + Sync {
    /// Initializes the metrics system, preparing it for data collection.
    async fn initialize(&self) -> CarbonResult<()>;
    /// Flushes any buffered metrics data to ensure all metrics are reported.
    async fn flush(&self) -> CarbonResult<()>;
    /// Shuts down the metrics system, performing cleanup and ensuring all data
    /// is flushed.
    async fn shutdown(&self) -> CarbonResult<()>;

    /// Updates a gauge metric, setting its value to represent the current
    /// state.
    ///
    /// # Parameters
    ///
    /// - `name`: The name of the gauge metric to update.
    /// - `value`: The current value of the gauge metric.
    async fn update_gauge(&self, name: &str, value: f64) -> CarbonResult<()>;

    /// Increments a counter metric by a specified value.
    ///
    /// # Parameters
    ///
    /// - `name`: The name of the counter metric to increment.
    /// - `value`: The amount by which to increment the counter.
    async fn increment_counter(&self, name: &str, value: u64) -> CarbonResult<()>;

    /// Records a value in a histogram metric, representing distribution data.
    ///
    /// # Parameters
    ///
    /// - `name`: The name of the histogram metric to record.
    /// - `value`: The value to add to the histogram, typically representing
    ///   time or size.
    async fn record_histogram(&self, name: &str, value: f64) -> CarbonResult<()>;
}

#[derive(Default)]
pub struct MetricsCollection {
    pub metrics: Vec<Arc<dyn Metrics>>,
}

impl MetricsCollection {
    pub fn new(metrics: Vec<Arc<dyn Metrics>>) -> Self {
        Self { metrics }
    }

    pub async fn initialize_metrics(&self) -> CarbonResult<()> {
        for metric in &self.metrics {
            metric.initialize().await?;
        }
        Ok(())
    }

    pub async fn shutdown_metrics(&self) -> CarbonResult<()> {
        for metric in &self.metrics {
            metric.shutdown().await?;
        }
        Ok(())
    }

    pub async fn flush_metrics(&self) -> CarbonResult<()> {
        for metric in &self.metrics {
            metric.flush().await?;
        }
        Ok(())
    }

    pub async fn update_gauge(&self, name: &str, value: f64) -> CarbonResult<()> {
        for metric in &self.metrics {
            metric.update_gauge(name, value).await?;
        }
        Ok(())
    }

    pub async fn increment_counter(&self, name: &str, value: u64) -> CarbonResult<()> {
        for metric in &self.metrics {
            metric.increment_counter(name, value).await?;
        }
        Ok(())
    }

    pub async fn record_histogram(&self, name: &str, value: f64) -> CarbonResult<()> {
        for metric in &self.metrics {
            metric.record_histogram(name, value).await?;
        }
        Ok(())
    }
}