Struct ErrorBudget 

pub struct ErrorBudget { /* private fields */ }

A concrete error budget: the allowable failures for a known event volume over an SLO period.

Create one with crate::Slo::error_budget.

Implementations

impl ErrorBudget

pub fn new(total_events: f64, budget_ratio: f64) -> Self

Build a budget directly from a total event count and the budget ratio (1 - objective).

pub fn total_events(&self) -> f64

Total events observed (or projected) over the period.

pub fn budget_ratio(&self) -> f64

The budget ratio, i.e. 1 - objective.

pub fn allowed_bad_events(&self) -> f64

The number of events that may fail before the budget is exhausted.

pub fn remaining_events(&self, observed_bad: f64) -> f64

Events of budget remaining after observed_bad failures. May be negative when the budget is overspent.

pub fn consumed_ratio(&self, observed_bad: f64) -> f64

Fraction of the budget already consumed by observed_bad failures (0.0 = untouched, 1.0 = exactly exhausted, > 1.0 = overspent).

pub fn remaining_ratio(&self, observed_bad: f64) -> f64

Fraction of the budget still available (1.0 = untouched, 0.0 = exhausted). Clamped at zero on the low end.

pub fn time_to_exhaustion( &self, observed_bad: f64, burn_rate: BurnRate, period: Window, ) -> Option<Duration>

Time until the budget is exhausted, given a sustained burn rate and the SLO period.

Returns None when the burn rate is zero or negative (the budget is never exhausted at that rate).

Trait Implementations

impl Clone for ErrorBudget

fn clone(&self) -> ErrorBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorBudget

impl Debug for ErrorBudget

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

Formats the value using the given formatter.

impl PartialEq for ErrorBudget

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ErrorBudget