Skip to main content

AlertEvaluator

Struct AlertEvaluator 

Source
pub struct AlertEvaluator { /* private fields */ }
Expand description

Consumes events and snapshots, applying AlertRules and emitting RuleAlerts with hysteresis and cooldown.

The evaluator is !Sync-free (it is plain Send state) and intended to be driven from a single monitoring task. Call observe_event for each incoming Event and observe_snapshot for each periodic EventSnapshot; both return any alerts produced.

Implementations§

Source§

impl AlertEvaluator

Source

pub fn new() -> Self

Create an evaluator with no rules.

Source

pub fn with_rule(self, rule: AlertRule) -> Self

Add a rule (builder style).

Source

pub fn add_rule(&mut self, rule: AlertRule)

Add a rule in place.

Source

pub fn rule_count(&self) -> usize

Number of configured rules.

Source

pub fn is_firing(&self, name: &str) -> bool

Whether the rule with name is currently firing.

Source

pub fn observe_event(&mut self, event: &Event) -> Vec<RuleAlert>

Observe a single event, updating internal windows and evaluating rules.

Returns any alerts (firing or resolved) produced as a result.

Source

pub fn observe_snapshot(&mut self, snapshot: &EventSnapshot) -> Vec<RuleAlert>

Observe a periodic snapshot, evaluating snapshot-driven rules.

Returns any alerts produced. Queue-depth and no-heartbeat rules are primarily evaluated here; failure-rate rules also incorporate the snapshot’s completed counts as additional samples.

Source

pub fn tick(&mut self, now: DateTime<Utc>) -> Vec<RuleAlert>

Explicitly evaluate time-based rules (e.g. no-heartbeat) at now.

Useful to call on a timer even when no events arrive, so a stalled cluster still trips the no-heartbeat rule.

Trait Implementations§

Source§

impl Debug for AlertEvaluator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AlertEvaluator

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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, 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