Skip to main content

QueueGauge

Struct QueueGauge 

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

Live usage gauge for a single bounded queue.

Cloneable handles share one gauge through an Arc; the registry keeps a Weak so a gauge is auto-pruned from snapshots once its queue is dropped.

Implementations§

Source§

impl QueueGauge

Source

pub fn name(&self) -> TrackedLimit

Stable limit name (used in logs and snapshots).

Source

pub fn category(&self) -> LimitCategory

The class of bounded resource this gauge tracks.

Source

pub fn capacity(&self) -> usize

Configured queue capacity (slots). 0 means unbounded / untracked.

Source

pub fn depth(&self) -> usize

Current observed depth.

Source

pub fn high_water(&self) -> usize

Highest depth observed over the gauge’s lifetime.

Source

pub fn observe_depth(&self, depth: usize)

Report the queue’s exact current depth (for queues whose backing channel exposes its live length, e.g. a Tokio mpsc via max_capacity - capacity).

Source

pub fn record_enqueue(&self)

Account for one item entering the queue (for manually-tracked queues).

Source

pub fn record_dequeue(&self)

Account for one item leaving the queue. Saturates at zero so a stray dequeue can never underflow the depth counter. Re-evaluates so a gauge that latched “warned” while full re-arms once the queue drains back below the re-arm threshold, even if the producer has since gone idle.

Trait Implementations§

Source§

impl Debug for QueueGauge

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> 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 = 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