metrix 0.11.0

metrics for application monitoring
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

//! Instruments that poll their values when a snapshot is requested.
//!
//! This is useful when you need to query values like currently opened DB
//! connections etc.

use crate::snapshot::*;
use crate::util;
use crate::{Descriptive, PutsSnapshot};

/// Create an instrument that delivers metrics based on querying values
/// when a `Snapshot` is requested.
///
/// The `Snapshot` can be generated from anything that
/// implements `PutsSnapshot`.
pub struct PollingInstrument<P> {
    /// If `create_group_with_name` is true, this name will create a new named
    /// group.
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub poll: P,
    pub create_group_with_name: bool,
}

impl<P> PollingInstrument<P>
where
    P: PutsSnapshot,
{
    pub fn new_with_defaults<T: Into<String>>(name: T, poll: P) -> PollingInstrument<P> {
        PollingInstrument {
            name: name.into(),
            title: None,
            description: None,
            poll,
            create_group_with_name: false,
        }
    }

    /// Gets the name of this `PollingInstrument`
    pub fn get_name(&self) -> &str {
        &self.name
    }

    /// Set the name if this `PollingInstrument`.
    ///
    /// The name is a path segment within a `Snapshot` if
    /// `self.create_group_with_name` is set to true.
    pub fn set_name<T: Into<String>>(&mut self, name: T) {
        self.name = name.into();
    }

    /// Returns whether a new group with the instruments name
    /// shall be craeted in the snapshot.
    pub fn create_group_with_name(&self) -> bool {
        self.create_group_with_name
    }

    /// Set to `true` if you want to create a new group
    /// with the name of this instrument when a `Snapshot`
    /// is requested.
    pub fn set_create_group_with_name(&mut self, create_group: bool) {
        self.create_group_with_name = create_group;
    }

    /// Sets the `title` of this `PollingInstrument`.
    ///
    /// A title can be part of a descriptive `Snapshot`
    pub fn set_title<T: Into<String>>(&mut self, title: T) {
        self.title = Some(title.into())
    }

    /// Sets the `description` of this `PollingInstrument`.
    ///
    /// A description can be part of a descriptive `Snapshot`
    pub fn set_description<T: Into<String>>(&mut self, description: T) {
        self.description = Some(description.into())
    }

    fn put_values_into_snapshot(&self, into: &mut Snapshot, descriptive: bool) {
        self.poll.put_snapshot(into, descriptive);
    }
}

impl<P> Descriptive for PollingInstrument<P> {
    fn title(&self) -> Option<&str> {
        self.title.as_ref().map(|n| &**n)
    }

    fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|n| &**n)
    }
}

impl<P> PutsSnapshot for PollingInstrument<P>
where
    P: PutsSnapshot,
{
    fn put_snapshot(&self, into: &mut Snapshot, descriptive: bool) {
        util::put_postfixed_descriptives(self, &self.name, into, descriptive);
        if self.create_group_with_name {
            let mut new_level = Snapshot::default();
            self.put_values_into_snapshot(&mut new_level, descriptive);
            into.items
                .push((self.name.clone(), ItemKind::Snapshot(new_level)));
        } else {
            self.put_values_into_snapshot(into, descriptive);
        }
    }
}

pub struct ConstantValue {
    name: String,
    title: Option<String>,
    description: Option<String>,
    value: ItemKind,
}

impl ConstantValue {
    pub fn new<T: Into<String>, V: Into<ItemKind>>(name: T, value: V) -> Self {
        ConstantValue {
            name: name.into(),
            title: None,
            description: None,
            value: value.into(),
        }
    }

    /// Set the name if this `PollingInstrument`.
    ///
    /// The name is a path segment within a `Snapshot` if
    /// `self.create_group_with_name` is set to true.
    pub fn set_name<T: Into<String>>(&mut self, name: T) {
        self.name = name.into();
    }

    /// Gets the name of this `PollingInstrument`
    pub fn get_name(&self) -> &str {
        &self.name
    }

    /// Sets the `title` of this `PollingInstrument`.
    ///
    /// A title can be part of a descriptive `Snapshot`
    pub fn set_title<T: Into<String>>(&mut self, title: T) {
        self.title = Some(title.into())
    }

    /// Sets the `description` of this `PollingInstrument`.
    ///
    /// A description can be part of a descriptive `Snapshot`
    pub fn set_description<T: Into<String>>(&mut self, description: T) {
        self.description = Some(description.into())
    }
}

impl PutsSnapshot for ConstantValue {
    fn put_snapshot(&self, into: &mut Snapshot, descriptive: bool) {
        util::put_postfixed_descriptives(self, &self.name, into, descriptive);
        into.items.push((self.name.clone(), self.value.clone()));
    }
}

impl Descriptive for ConstantValue {
    fn title(&self) -> Option<&str> {
        self.title.as_ref().map(|n| &**n)
    }

    fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|n| &**n)
    }
}