Skip to main content

PressureMonitor

Struct PressureMonitor 

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

Tracks pressure metrics and derives channel pressure scores.

Implementations§

Source§

impl PressureMonitor

Source

pub fn new() -> Self

Creates an empty pressure monitor with the default average-utilization scorer.

Source

pub fn with_scoring<F>(scoring: F) -> Self
where F: Fn(&[ConsumerPressureMetrics]) -> f64 + Send + Sync + 'static,

Creates an empty pressure monitor using a caller-supplied scoring function.

Source

pub fn is_empty(&self) -> bool

Returns true when no consumers are tracked on any channel.

Source

pub fn total_consumer_count(&self) -> usize

Returns the number of consumers tracked across all channels.

Source

pub fn record_consumer_metrics( &mut self, channel_id: impl Into<String>, consumer_id: impl Into<String>, metrics: ConsumerPressureMetrics, ) -> ChannelPressureSnapshot

Records the latest metrics for a consumer and returns the updated channel snapshot.

Source

pub fn record_accept( &mut self, channel_id: impl Into<String>, consumer_id: impl Into<String>, ) -> ChannelPressureSnapshot

Records one accept decision for a consumer and returns the updated channel snapshot.

Source

pub fn record_defer( &mut self, channel_id: impl Into<String>, consumer_id: impl Into<String>, ) -> ChannelPressureSnapshot

Records one defer decision for a consumer and returns the updated channel snapshot.

Source

pub fn record_reject( &mut self, channel_id: impl Into<String>, consumer_id: impl Into<String>, ) -> ChannelPressureSnapshot

Records one reject decision for a consumer and returns the updated channel snapshot.

Source

pub fn consumer_metrics( &self, channel_id: &str, consumer_id: &str, ) -> Option<&ConsumerPressureMetrics>

Returns the latest metrics recorded for one consumer.

Source

pub fn consumer_utilization( &self, channel_id: &str, consumer_id: &str, ) -> Option<f64>

Returns the latest utilization for one consumer.

Source

pub fn channel_pressure(&self, channel_id: &str) -> f64

Returns the current aggregate pressure score for a channel.

Source

pub fn channel_consumer_count(&self, channel_id: &str) -> usize

Returns the current number of tracked consumers for a channel.

Source

pub fn channel_snapshot(&self, channel_id: &str) -> ChannelPressureSnapshot

Returns an observable snapshot for one channel.

Trait Implementations§

Source§

impl Debug for PressureMonitor

Source§

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

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

impl Default for PressureMonitor

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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