Skip to main content

AlertRule

Struct AlertRule 

Source
pub struct AlertRule {
    pub name: String,
    pub severity: AlertSeverity,
    pub kind: AlertRuleKind,
    pub cooldown: Duration,
}
Expand description

A configured alerting rule.

Each rule carries a unique name, a AlertSeverity, the monitored AlertRuleKind, and a cooldown that suppresses repeat alerts while the rule remains continuously tripped.

Fields§

§name: String

Unique rule identifier (also used as the alert’s rule_name).

§severity: AlertSeverity

Severity attached to alerts produced by this rule.

§kind: AlertRuleKind

The condition being monitored.

§cooldown: Duration

Minimum time between successive firing alerts for this rule.

Implementations§

Source§

impl AlertRule

Source

pub fn failure_rate( name: impl Into<String>, severity: AlertSeverity, trip_threshold: f64, ) -> Self

Build a failure-rate rule. By default the clear threshold equals the trip threshold (no hysteresis), the window is 60s, min_samples is 1 and the cooldown is 60s; adjust with the builder methods.

Source

pub fn queue_depth( name: impl Into<String>, severity: AlertSeverity, trip_depth: u64, ) -> Self

Build a queue-depth rule. Clear depth defaults to the trip depth.

Source

pub fn no_heartbeat( name: impl Into<String>, severity: AlertSeverity, timeout: Duration, ) -> Self

Build a no-heartbeat rule.

Source

pub fn with_cooldown(self, cooldown: Duration) -> Self

Set the cooldown between repeated firing alerts.

Source

pub fn with_clear_threshold(self, clear: f64) -> Self

Set the clear threshold for a failure-rate rule (enables hysteresis).

Source

pub fn with_window(self, window: Duration) -> Self

Set the sliding window for a failure-rate rule.

Source

pub fn with_min_samples(self, min_samples: u64) -> Self

Set the minimum samples for a failure-rate rule.

Source

pub fn with_clear_depth(self, clear: u64) -> Self

Set the clear depth for a queue-depth rule (enables hysteresis).

Source

pub fn for_queue(self, queue: impl Into<String>) -> Self

Watch a specific queue for a queue-depth rule.

Trait Implementations§

Source§

impl Clone for AlertRule

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AlertRule

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more