wire-framework 0.1.0

A DI library for Rust
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

//! Metrics for health checks.

use std::time::Duration;

use vise::{
    Buckets, DurationAsSecs, EncodeLabelSet, EncodeLabelValue, Family, Histogram, Info, Metrics,
    Unit,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, EncodeLabelValue)]
#[metrics(rename_all = "snake_case")]
pub(crate) enum CheckResult {
    Slow,
    TimedOut,
    Dropped,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, EncodeLabelSet)]
struct AbnormalCheckLabels {
    component: &'static str,
    result: CheckResult,
}

#[derive(Debug, EncodeLabelSet)]
pub(crate) struct AppHealthCheckConfig {
    #[metrics(unit = Unit::Seconds)]
    pub slow_time_limit: DurationAsSecs,
    #[metrics(unit = Unit::Seconds)]
    pub hard_time_limit: DurationAsSecs,
}

#[derive(Debug, Metrics)]
#[metrics(prefix = "healthcheck")]
pub(crate) struct HealthMetrics {
    /// Immutable configuration for application health checks.
    pub info: Info<AppHealthCheckConfig>,
    /// Latency for abnormal checks. Includes slow, dropped and timed out checks (distinguished by the "result" label);
    /// skips normal checks.
    #[metrics(buckets = Buckets::LATENCIES, unit = Unit::Seconds)]
    abnormal_check_latency: Family<AbnormalCheckLabels, Histogram<Duration>>,
}

impl HealthMetrics {
    pub fn observe_abnormal_check(
        &self,
        component: &'static str,
        result: CheckResult,
        duration: Duration,
    ) {
        let labels = AbnormalCheckLabels { component, result };
        self.abnormal_check_latency[&labels].observe(duration);
    }
}

#[vise::register]
pub(crate) static METRICS: vise::Global<HealthMetrics> = vise::Global::new();