rs-zero 0.2.6

Rust-first microservice framework inspired by go-zero engineering practices
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

use std::{collections::BTreeMap, fmt::Write};

use super::escape_label;

/// Low-cardinality labels recorded for a cache event.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct CacheMetricLabels {
    /// Cache component, for example `cache_aside`, `lru` or `two_level`.
    pub component: String,
    /// Cache operation category.
    pub operation: String,
    /// Result category.
    pub result: String,
}

impl CacheMetricLabels {
    /// Creates a cache event label set without carrying cache keys.
    pub fn new(
        component: impl Into<String>,
        operation: impl Into<String>,
        result: impl Into<String>,
    ) -> Self {
        Self {
            component: component.into(),
            operation: operation.into(),
            result: result.into(),
        }
    }
}

pub(crate) fn render(output: &mut String, metrics: &BTreeMap<CacheMetricLabels, u64>) {
    output.push_str(
        "# HELP rs_zero_cache_events_total Cache events by component, operation and result.\n",
    );
    output.push_str("# TYPE rs_zero_cache_events_total counter\n");
    for (labels, value) in metrics {
        writeln!(
            output,
            "rs_zero_cache_events_total{{component=\"{}\",operation=\"{}\",result=\"{}\"}} {}",
            escape_label(&labels.component),
            escape_label(&labels.operation),
            escape_label(&labels.result),
            value
        )
        .ok();
    }
}