pipedash-core 0.9.0

Framework-agnostic core library for Pipedash
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

use chrono::{
    DateTime,
    Utc,
};
pub use pipedash_plugin_api::{
    ComponentHealth,
    HealthLevel,
};
use serde::{
    Deserialize,
    Serialize,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SignalKind {
    StatusPage,
    Instance,
    Connection,
    RateLimit,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum EvidenceView {
    Fresh,
    Stale,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Incident {
    pub id: String,
    pub name: String,
    pub level: HealthLevel,
    pub phase: String,
    pub latest_update: Option<String>,
    pub url: Option<String>,
    pub started_at: Option<DateTime<Utc>>,
    pub updated_at: DateTime<Utc>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Maintenance {
    pub id: String,
    pub name: String,
    pub in_progress: bool,
    pub starts_at: Option<DateTime<Utc>>,
    pub ends_at: Option<DateTime<Utc>>,
    pub url: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct HealthSignal {
    pub kind: SignalKind,
    pub episode_id: String,
    pub level: HealthLevel,
    pub evidence: EvidenceView,
    pub observed_at: DateTime<Utc>,
    pub title: String,
    pub detail: Option<String>,
    pub reported_by: String,
    pub url: Option<String>,
    pub components: Vec<ComponentHealth>,
    pub incidents: Vec<Incident>,
    pub maintenances: Vec<Maintenance>,
    pub updated_at: DateTime<Utc>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StatusPageRef {
    pub name: String,
    pub url: String,
    pub checked_at: Option<DateTime<Utc>>,
    pub error: Option<String>,
    #[serde(default)]
    pub components: Vec<ComponentHealth>,
    #[serde(default)]
    pub other_incidents: Vec<Incident>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ProviderHealth {
    pub level: HealthLevel,
    pub signals: Vec<HealthSignal>,
    pub next_attempt_at: Option<DateTime<Utc>>,
    pub in_flight: bool,
    pub status_page: Option<StatusPageRef>,
}

impl Default for ProviderHealth {
    fn default() -> Self {
        Self {
            level: HealthLevel::Operational,
            signals: Vec::new(),
            next_attempt_at: None,
            in_flight: false,
            status_page: None,
        }
    }
}