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
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

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

use super::{DurationMetricValue, escape_label, write_duration_metric};

/// Low-cardinality labels recorded for a SQL query.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct SqlMetricLabels {
    /// Database kind, for example `sqlite`, `postgres` or `mysql`.
    pub db_kind: String,
    /// Repository or component name.
    pub repository: String,
    /// Repository method or operation owner.
    pub method: String,
    /// SQL operation category such as `select`, `insert` or `delete`.
    pub operation: String,
    /// Result category, usually `success` or `error`.
    pub result: String,
}

impl SqlMetricLabels {
    /// Creates a SQL label set without carrying SQL text or parameters.
    pub fn new(
        db_kind: impl Into<String>,
        repository: impl Into<String>,
        method: impl Into<String>,
        operation: impl Into<String>,
        result: impl Into<String>,
    ) -> Self {
        Self {
            db_kind: db_kind.into(),
            repository: repository.into(),
            method: method.into(),
            operation: operation.into(),
            result: result.into(),
        }
    }
}

pub(crate) fn render(
    output: &mut String,
    metrics: &BTreeMap<SqlMetricLabels, DurationMetricValue>,
) {
    output.push_str("# HELP rs_zero_sql_queries_total Total number of SQL queries.\n");
    output.push_str("# TYPE rs_zero_sql_queries_total counter\n");
    for (labels, value) in metrics {
        write!(output, "rs_zero_sql_queries_total{{").ok();
        write_labels(output, labels, None);
        writeln!(output, "}} {}", value.count).ok();
    }

    output.push_str("# HELP rs_zero_sql_query_errors_total Total number of failed SQL queries.\n");
    output.push_str("# TYPE rs_zero_sql_query_errors_total counter\n");
    for (labels, value) in metrics
        .iter()
        .filter(|(labels, _)| labels.result != "success")
    {
        write!(output, "rs_zero_sql_query_errors_total{{").ok();
        write_labels(output, labels, None);
        writeln!(output, "}} {}", value.count).ok();
    }

    output.push_str("# HELP rs_zero_sql_query_duration_seconds SQL query duration.\n");
    output.push_str("# TYPE rs_zero_sql_query_duration_seconds histogram\n");
    for (labels, value) in metrics {
        write_duration_metric(
            output,
            "rs_zero_sql_query_duration_seconds",
            labels,
            value,
            write_labels,
        );
    }
}

fn write_labels(output: &mut String, labels: &SqlMetricLabels, le: Option<&str>) {
    write!(
        output,
        "db_kind=\"{}\",repository=\"{}\",method=\"{}\",operation=\"{}\",result=\"{}\"",
        escape_label(&labels.db_kind),
        escape_label(&labels.repository),
        escape_label(&labels.method),
        escape_label(&labels.operation),
        escape_label(&labels.result)
    )
    .ok();
    if let Some(le) = le {
        write!(output, ",le=\"{}\"", escape_label(le)).ok();
    }
}