Skip to main content

BudgetMonitor

Struct BudgetMonitor 

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

Tracks budget violations over time windows for alerting.

The monitor aggregates violations per task and checks against configurable thresholds. When a task exceeds its threshold, an alert is generated.

§Example

use laminar_core::budget::BudgetMonitor;
use std::time::Duration;

let mut monitor = BudgetMonitor::new(
    Duration::from_secs(60),  // 1 minute window
    10.0,                      // Alert if > 10 violations/sec
);

// Record violations
monitor.record_violation("ring0_event", 0, 100);

// Check for alerts
let alerts = monitor.check_alerts();
for alert in alerts {
    eprintln!("ALERT: {} has {} violations/sec", alert.task, alert.violation_rate);
}

Implementations§

Source§

impl BudgetMonitor

Source

pub fn new(window: Duration, threshold: f64) -> Self

Create a new budget monitor.

§Arguments
  • window - Time window for rate calculation (e.g., 60 seconds)
  • threshold - Alert threshold in violations per second
Source

pub fn record_violation(&mut self, task: &str, ring: u8, exceeded_by_ns: u64)

Record a budget violation.

§Arguments
  • task - Task name that violated budget
  • ring - Ring number (0, 1, or 2)
  • exceeded_by_ns - How much the budget was exceeded in nanoseconds
Source

pub fn check_alerts(&mut self) -> Vec<BudgetAlert>

Check for alerts based on configured threshold.

Returns a list of alerts for tasks exceeding the threshold. Call this periodically (e.g., every second).

Source

pub fn violation_count(&self, task: &str) -> u64

Get current violation count for a task.

Source

pub fn threshold(&self) -> f64

Get the alert threshold (violations per second).

Source

pub fn set_threshold(&mut self, threshold: f64)

Update the alert threshold.

Source

pub fn window(&self) -> Duration

Get the window duration.

Source

pub fn reset(&mut self)

Reset all violation tracking.

Source

pub fn violations(&self) -> &HashMap<String, ViolationWindow>

Get all current violation windows.

Trait Implementations§

Source§

impl Debug for BudgetMonitor

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,