Struct Monitor 

pub struct Monitor {

    pub name: String,
    pub kind: Kind,
    pub url: Option<String>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub app: Option<String>,
    pub stack: Option<String>,
    pub service: Option<String>,
    pub domain: Option<String>,
    pub path: Option<String>,
    pub method: String,
    pub expected_status: String,
    pub keyword: Option<String>,
    pub keyword_absent: Option<String>,
    pub follow_redirects: bool,
    pub headers: Vec<Header>,
    pub interval: u64,
    pub timeout: u64,
    pub failure_threshold: u32,
    pub recovery_threshold: u32,
    pub cert_expiry_days: u32,
    pub paused: bool,
    pub auto: bool,
    pub created_at: u64,
    pub updated_at: u64,
}

One monitor. Fields that do not apply to its type are refused.

Fields

name: String

kind: Kind

url: Option<String>

http: the URL.

host: Option<String>

tcp: host and port.

port: Option<u16>

app: Option<String>

app: the app, by name.

stack: Option<String>

service: the compose stack, by name.

service: Option<String>

service: the stack’s service, by name.

domain: Option<String>

app, service: which of its domains (default: the first one served).

path: Option<String>

app, service: the path to request (default: the path the service’s healthcheck requests over HTTP, else the domain’s path).

method: String

GET or HEAD.

expected_status: String

Status codes that count as up: 200-399, 200,204, 200-299,301.

keyword: Option<String>

The body must contain this.

keyword_absent: Option<String>

The body must not contain this.

follow_redirects: bool

headers: Vec<Header>

interval: u64

Seconds between checks (at least 30).

timeout: u64

Seconds one check may take.

failure_threshold: u32

Failed checks in a row that make it down.

recovery_threshold: u32

Successful checks in a row that make it up again.

cert_expiry_days: u32

Warn this many days before an HTTPS certificate expires (0: never).

paused: bool

auto: bool

Made for an app (app-<name>) or a compose stack service (stack-<stack>-<service>) with a served domain.

created_at: u64

updated_at: u64

Implementations

impl Monitor

pub fn new(name: &str, kind: Kind) -> Monitor

A bare monitor of kind with every default.

pub fn validate(&self) -> Result<()>

Check everything but whether an app or secret exists.

pub fn follows(&self) -> bool

Does it follow something by reference (an app or a stack service)?

pub fn secrets(&self) -> Vec<&str>

The secrets the monitor reads.

pub fn target(&self) -> String

What it checks, in a few words.

Trait Implementations

impl Clone for Monitor

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Monitor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Monitor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Monitor

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Monitor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Monitor