Skip to main content

SystemHealthReport

Struct SystemHealthReport 

Source
pub struct SystemHealthReport {
    pub components: Vec<HealthComponentReport>,
    pub duration: Option<Duration>,
}
Expand description

Aggregate health report for a service instance.

Fields§

§components: Vec<HealthComponentReport>

Component reports included in this health check run.

§duration: Option<Duration>

Total duration of the aggregate health run.

Implementations§

Source§

impl SystemHealthReport

Source

pub fn new(components: Vec<HealthComponentReport>) -> Self

Returns a report from component entries.

Source

pub fn with_duration( components: Vec<HealthComponentReport>, duration: Duration, ) -> Self

Returns a report from component entries and aggregate duration.

Source

pub fn duration_seconds(&self) -> Option<f64>

Returns aggregate duration in seconds, if present.

Source

pub fn record_metrics<R>(&self, scope: &'static str, recorder: &R)

Records this report through a product-provided metrics bridge.

Source

pub fn has_issues(&self) -> bool

Returns whether any component is degraded or unhealthy.

Source

pub fn status(&self) -> HealthStatus

Returns the worst status across all components.

Unhealthy dominates Degraded, and an empty report is considered healthy because no product probe reported an issue.

Source

pub fn summary(&self) -> String

Returns a compact operator-facing summary.

Source

pub fn details(&self) -> String

Returns component status and diagnostic messages for every component.

Source

pub fn issue_summary(&self) -> String

Returns a compact summary of only degraded or unhealthy components.

When no component reports an issue, this falls back to Self::summary.

Source

pub fn issue_details(&self) -> String

Returns diagnostic details for only degraded or unhealthy components.

When no component reports an issue, this falls back to Self::details.

Trait Implementations§

Source§

impl Clone for SystemHealthReport

Source§

fn clone(&self) -> SystemHealthReport

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 SystemHealthReport

Source§

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

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

impl PartialEq for SystemHealthReport

Source§

fn eq(&self, other: &SystemHealthReport) -> 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 Eq for SystemHealthReport

Source§

impl StructuralPartialEq for SystemHealthReport

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more