ops-core 0.2.0

Core checker trait for ops.
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

pub use async_trait::async_trait;

/// An interface for something that can be periodically checked.
#[async_trait]
pub trait Checker: Send + Sync {
    /// Runs the check and returns a [`CheckResponse`](struct.CheckResponse.html).
    async fn check(&self) -> CheckResponse;
}

/// The response of a check.
#[derive(Debug)]
pub struct CheckResponse {
    health: Health,
    output: String,
    action: Option<String>,
    impact: Option<String>,
}

impl CheckResponse {
    /// Creates a healthy [`CheckResponse`](struct.CheckResponse.html).
    pub fn healthy(output: &str) -> Self {
        CheckResponse {
            health: Health::Healthy,
            output: output.to_owned(),
            action: None,
            impact: None,
        }
    }

    /// Creates a degraded [`CheckResponse`](struct.CheckResponse.html).
    pub fn degraded(output: &str, action: &str) -> Self {
        CheckResponse {
            health: Health::Degraded,
            output: output.to_owned(),
            action: Some(action.to_owned()),
            impact: None,
        }
    }

    /// Creates an unhealthy [`CheckResponse`](struct.CheckResponse.html).
    pub fn unhealthy(output: &str, action: &str, impact: &str) -> Self {
        CheckResponse {
            health: Health::Unhealthy,
            output: output.to_owned(),
            action: Some(action.to_owned()),
            impact: Some(impact.to_owned()),
        }
    }

    /// Health status of the check.
    pub fn health(&self) -> Health {
        self.health
    }

    /// Text representation of the current status.
    pub fn output(&self) -> &str {
        &self.output
    }

    /// Action to resolve the issue if non-healthy.
    pub fn action(&self) -> Option<&str> {
        self.action.as_ref().map(String::as_ref)
    }

    /// Impact of not fixing the issue.
    pub fn impact(&self) -> Option<&str> {
        self.impact.as_ref().map(String::as_ref)
    }
}

/// Health statuses.
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub enum Health {
    Healthy,
    Degraded,
    Unhealthy,
}

impl Into<&'static str> for Health {
    fn into(self) -> &'static str {
        match self {
            Health::Healthy => "healthy",
            Health::Degraded => "degraded",
            Health::Unhealthy => "unhealthy",
        }
    }
}