Skip to main content

HealthConfig

Struct HealthConfig 

Source
pub struct HealthConfig {
    pub system_cpu: Vec<Step>,
    pub load_avg: Vec<Step>,
    pub process_cpu: Vec<Step>,
    pub memory_gb: Vec<Step>,
    pub threads: Vec<Step>,
    pub fds: Vec<Step>,
}
Expand description

Configurable thresholds for SystemHealth::quick_check / SystemHealth::health_score.

Each metric (system_cpu / load_avg / process_cpu / memory_gb / threads / fds) accepts a list of Steps. When the metric exceeds a step’s threshold, the step’s penalty is subtracted from the running score (starting at 100). The first matching step wins, so list steps in descending threshold order.

The load-average steps are interpreted as multipliers of num_cpus::get() (e.g. Step::new(2.0, 25.0) applies when load exceeds 2 × CPU count).

The defaults in HealthConfig::default match the v0.9.x behavior exactly so existing dashboards do not shift unexpectedly.

§Example

use metrics_lib::{HealthConfig, Step, SystemHealth};
use std::time::Duration;

// Stricter CPU thresholds for a CPU-bound workload.
let cfg = HealthConfig {
    system_cpu: vec![
        Step::new(70.0, 30.0),
        Step::new(50.0, 15.0),
        Step::new(30.0, 5.0),
    ],
    ..HealthConfig::default()
};
let health = SystemHealth::with_config(Duration::from_millis(500), cfg);
let _ = health.health_score();

Fields§

§system_cpu: Vec<Step>

Penalty steps applied to the system-wide CPU percentage (0..=100).

§load_avg: Vec<Step>

Penalty steps applied to the 1-minute load average, expressed as a multiplier of num_cpus::get() (e.g. threshold 2.0 ⇒ trips when load > 2× cores).

§process_cpu: Vec<Step>

Penalty steps applied to the process CPU percentage (0..=100).

§memory_gb: Vec<Step>

Penalty steps applied to system memory used, in gigabytes.

§threads: Vec<Step>

Penalty steps applied to the process thread count.

§fds: Vec<Step>

Penalty steps applied to the process file-descriptor count.

Trait Implementations§

Source§

impl Clone for HealthConfig

Source§

fn clone(&self) -> HealthConfig

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 Debug for HealthConfig

Source§

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

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

impl Default for HealthConfig

Source§

fn default() -> Self

Defaults match the v0.9.x scoring exactly. Each Vec<Step> is ordered descending by threshold so the first match wins.

Source§

impl PartialEq for HealthConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for HealthConfig

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.