prometric 0.2.2

Metric types to use with the prometric-derive crate.
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

/// Abstracts over the representation of the Summary data
pub trait Summary {
    /// Computes the sum of all the samples in the summary
    fn sample_sum(&self) -> f64;

    /// Returns the number of samples in the summary
    fn sample_count(&self) -> u64;

    /// Attempt to compute the value for the given quantile
    fn quantile(&self, _: f64) -> Option<f64>;
}

/// Abstracts over the metric summary logic user to compute the given quantile results
pub trait SummaryProvider {
    type Opts: Clone + Send + Sync;
    type Summary: Summary;

    /// Create a new instance of the given provider
    fn new_provider(opts: &Self::Opts) -> Self;

    /// Add a new data point to the summary's collection
    fn observe(&self, _: f64);

    /// Return the current summary computed over the observations
    fn snapshot(&self) -> Self::Summary;
}

/// Abstracts over the metric summary logic user to compute the given quantile results
///
/// Differing from [`SummaryProvider`] by the `observe` `&mut self` requirement.
pub trait NonConcurrentSummaryProvider {
    type Opts: Clone + Send + Sync;
    type Summary: Summary;

    /// Create a new instance of the given provider
    fn new_provider(opts: &Self::Opts) -> Self;

    /// Add a new data point to the summary's collection
    fn observe(&mut self, _: f64);

    /// Return the current summary computed over the observations
    fn snapshot(&self) -> Self::Summary;
}

impl<T: SummaryProvider> NonConcurrentSummaryProvider for T {
    type Opts = T::Opts;
    type Summary = T::Summary;

    fn new_provider(opts: &Self::Opts) -> Self {
        <Self as SummaryProvider>::new_provider(opts)
    }

    fn observe(&mut self, val: f64) {
        SummaryProvider::observe(self, val)
    }

    fn snapshot(&self) -> Self::Summary {
        SummaryProvider::snapshot(self)
    }
}

/// Marker trait (or alias) for a [`Summary`] which can be used by
/// [`crate::summary::generic::GenericSummary`] to implement [`prometheus::Metric`]
pub trait SummaryMetric: NonConcurrentSummaryProvider + Send + Sync + Clone {}
impl<T: NonConcurrentSummaryProvider + Send + Sync + Clone> SummaryMetric for T {}