mackerel_plugin 0.2.6

Mackerel plugin helper library
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

use serde_derive::{Deserialize, Serialize};

use crate::metric::Metric;
use crate::unit::Unit;

/// A graph represents a Mackerel graph schema.
#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct Graph {
    #[serde(skip_serializing)]
    pub name: String,
    pub label: String,
    pub unit: Unit,
    pub metrics: Vec<Metric>,
}

impl Graph {
    #[doc(hidden)]
    pub fn has_diff(&self) -> bool {
        self.metrics.iter().any(|metric| metric.diff)
    }
}

/// Builds a new [`Graph`].
///
/// ```rust
/// use mackerel_plugin::graph;
///
/// let graph = graph! {
///     name: "linux.swap",
///     label: "Linux Swap Usage",
///     unit: "integer",
///     metrics: [
///         { name: "pswpin", label: "Swap In", diff: true },
///         { name: "pswpout", label: "Swap Out", diff: true },
///     ],
/// };
/// ```
#[macro_export]
macro_rules! graph {
    (
        name: $name:expr,
        label: $label:expr,
        unit: $unit:expr,
        metrics: [$( {$( $metrics:tt )*} ),+ $(,)?] $(,)?
    ) => {{
        assert!(
            str::chars($name).all(|c| matches!(c, 'a'..='z' | 'A'..='Z' | '0'..='9' | '-' | '_' | '.' | '*' | '#'))
                && !$name.starts_with('.') && !$name.ends_with('.')
        );
        $crate::Graph {
            name: $name.into(),
            label: $label.into(),
            unit: $unit.parse().unwrap(),
            metrics: vec![$( $crate::metric! {$( $metrics )*} ),+],
        }
    }};

    ($($_:tt)*) => {
        compile_error!("name, label, unit, and metrics are required");
    };
}