telemetry 0.1.3

Telemetry is a mechanism used to capture metrics in an application, to later store the data locally or upload it to a server for statistical analysis.
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

///!
///! Misc stuff used throughout the crate.
///!

///
/// A storage with a name attached.
///
/// Typically, `T` will be either a `PlainRawStorage` or a `KeyedRawStorage`.
///
pub struct NamedStorage<T: ?Sized> {
    /// The name of the storage. Also used as a key, must be unique.
    pub name: String,

    ///
    pub contents: Box<T>,
}

///
/// A subset of data to serialize.
///
pub enum Subset {
    /// Serialize all plain histograms.
    AllPlain,

    /// Serialize all keyed histograms.
    AllKeyed,
}

///
/// A subformat of Json to use for serialization.
///
pub enum SerializationFormat {
    ///
    /// Simple Json:
    /// - `Flag` are represented as a single boolean;
    /// - `KeyedFlag` are represented as an array;
    /// - `Linear` are represented as an array of numbers, one cell per bucket;
    /// - `KeyedLinear` are represented as an object, one field per histogram,
    ///    with name = key, value = array of numbers as for `Linear`;
    /// - ...
    ///
    SimpleJson,
}

///
/// A value that can be represented as a u32.
///
pub trait Flatten {
    fn as_u32(&self) -> u32;
}

impl Flatten for u32 {
    fn as_u32(&self) -> u32 {
        *self
    }
}

impl Flatten for () {
    fn as_u32(&self) -> u32 {
        0
    }
}

impl Flatten for bool {
    fn as_u32(&self) -> u32 {
        if *self {
            1
        } else {
            0
        }
    }
}

//
// Representation of buckets shared by both plain and keyed linear histograms.
//
pub struct LinearBuckets {
    min: u32,
    max: u32, // Invariant: max > min
    pub buckets: usize,
}

impl LinearBuckets {
    pub fn new(min: u32, max: u32, buckets: usize) -> LinearBuckets {
        assert!(min < max);
        assert!(buckets > 0);
        assert!(buckets < (max - min) as usize);
        LinearBuckets { min, max, buckets }
    }

    pub fn get_bucket(&self, value: u32) -> usize {
        if value <= self.min {
            0
        } else if value >= self.max {
            self.buckets - 1 as usize
        } else {
            let num = value as f32 - self.min as f32;
            let den = self.max as f32 - self.min as f32;
            let res = (num / den) * self.buckets as f32;
            res as usize
        }
    }
}

pub fn vec_with_size<T>(size: usize, value: T) -> Vec<T>
where
    T: Clone,
{
    let mut vec = Vec::with_capacity(size);
    vec.resize(size, value);
    vec
}