Struct shipcat_definitions::structs::prometheusalert::PrometheusAlert

pub struct PrometheusAlert {
    pub name: String,
    pub summary: String,
    pub description: String,
    pub expr: String,
    pub min_duration: String,
    pub severity: PrometheusAlertSeverity,
}

Data describing one Prometheus alert.

This roughly corresponds to a Rule object in the Prometheus Operator API spec: https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#rule

Fields

name: String

Name of the alert

Must be in PascalCase.

summary: String

Summary of the alert.

A one-line summary of the problem this alert captures.

description: String

Description of the alert.

A more verbose description of the problem should go here, together with any suggested actions or links to further resources useful to an on-call engineer responding to this issue.

expr: String

PromQL expression defining this alert.

Whenever a new timeseries is returned by this expression, a new alert enters pending state.

min_duration: String

Minimum duration of a problem before an alert fires.

This is the minimum duration a pending alert must remain active for in order to actually fire. Examples: ‘15m’, ‘1h’.

severity: PrometheusAlertSeverity

Severity of the alert.

Corresponds to how urgently it should be actioned if it were in production.

Implementations

impl PrometheusAlert

pub fn verify(&self, svc: &str) -> Result<()>

Trait Implementations

impl Clone for PrometheusAlert

fn clone(&self) -> PrometheusAlert

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrometheusAlert

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrometheusAlert

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for PrometheusAlert

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

Serialize this value into the given Serde serializer.