nom-openmetrics 0.2.0

A prometheus and openmetrics parser
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

/// The HELP, TYPE, and UNIT of a metric
#[derive(Debug, PartialEq)]
pub enum MetricDescriptor<'a> {
    /// The `MetricType`
    Type {
        metric: &'a str,
        r#type: MetricType<'a>,
    },
    /// The metric description
    Help { metric: &'a str, help: String },
    /// The metric unit
    Unit { metric: &'a str, unit: &'a str },
}

impl<'a> MetricDescriptor<'a> {
    /// Crate a HELP descriptor
    pub fn help(metric: &'a str, help: String) -> Self {
        Self::Help { metric, help }
    }

    /// Crate a TYPE descriptor
    pub fn r#type(metric: &'a str, r#type: MetricType<'a>) -> Self {
        Self::Type { metric, r#type }
    }

    /// Crate a UNIT descriptor
    pub fn unit(metric: &'a str, unit: &'a str) -> Self {
        Self::Unit { metric, unit }
    }

    /// The metric name
    pub fn metric(&self) -> &'a str {
        match self {
            MetricDescriptor::Type { metric, .. }
            | MetricDescriptor::Help { metric, .. }
            | MetricDescriptor::Unit { metric, .. } => metric,
        }
    }
}

/// The type of the metric
#[derive(Debug, PartialEq, strum::Display)]
pub enum MetricType<'a> {
    /// A counter measures discrete events
    Counter,
    /// A guage measures a current value
    Gauge,
    /// A gauge histogram measures current distributions
    Gaugehistogram,
    /// A distribution of discrete events
    Histogram,
    /// Exposes textual information through labels
    Info,
    /// A series of related boolean values
    Stateset,
    /// A quantile summary of discrete events
    Summary,
    /// Unknown type
    #[strum(to_string = "{0}")]
    Unknown(&'a str),
}