Skip to main content

SystemCpuTracker

Struct SystemCpuTracker 

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

Aggregate machine CPU utilization from cumulative CPU-time totals (§8.3).

The percentage is busy_delta / (busy_delta + idle_delta). That divisor is CPU time rather than wall time, which makes the result self-normalizing: it is already a share of all logical CPUs, so it lands in 0..=100 without ever being told the CPU count, and a sample interval that drifts from 1 s to 4 s cannot distort it.

The reading Instant is retained even though the percentage does not use it, so that a keyed set of per-core trackers can prune cores that stopped reporting after a CPU hotplug event.

Implementations§

Source§

impl SystemCpuTracker

Source

pub const fn new() -> Self

Builds a tracker with no baseline.

Source

pub const fn is_warming_up(&self) -> bool

Whether the next reading will be the first, and so warming up (§8.2).

Source

pub const fn last_observed_at(&self) -> Option<Instant>

When the last reading was accepted, or None while warming up.

Source

pub fn forget_baseline(&mut self)

Drops the baseline so the next reading warms up again.

Source

pub fn observe( &mut self, totals: CpuTimeTotals, at: Instant, ) -> MetricState<Percent>

Folds one cumulative CPU-time reading in and publishes machine usage.

Trait Implementations§

Source§

impl Clone for SystemCpuTracker

Source§

fn clone(&self) -> SystemCpuTracker

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SystemCpuTracker

Source§

impl Debug for SystemCpuTracker

Source§

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

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

impl Default for SystemCpuTracker

Source§

fn default() -> SystemCpuTracker

Returns the “default value” for a type. Read more
Source§

impl DeltaTracker for SystemCpuTracker

Source§

type Config = ()

Construction parameters shared by every tracker in one set. Read more
Source§

type Reading = CpuTimeTotals

The cumulative reading folded in on each observation.
Source§

type Value = Percent

The value published when an observation succeeds.
Source§

fn with_config(_config: Self::Config) -> Self

Builds a tracker with no baseline yet.
Source§

fn observe_reading( &mut self, reading: Self::Reading, at: Instant, ) -> MetricState<Self::Value>

Folds one cumulative reading in, at monotonic time at.
Source§

fn last_observed_at(&self) -> Option<Instant>

When this tracker last accepted a reading, or None while warming up.
Source§

fn forget_baseline(&mut self)

Drops the baseline so the next reading warms up instead of producing a delta across a gap (§8.2).

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.