Struct HealthReport 

pub struct HealthReport {
    pub overall: HealthStatus,
    pub components: Vec<ComponentHealth>,
    pub checked_at: SystemTime,
}

Aggregated health report for all registered components.

Returned by HealthReporter::report.

Fields

overall: HealthStatus

Overall system status (worst of all components)

components: Vec<ComponentHealth>

Per-component breakdown

checked_at: SystemTime

When this report was generated (Unix seconds)

Implementations

impl HealthReport

pub fn is_ready(&self) -> bool

Returns true when the system is ready to serve traffic.

The system is ready only when all components are healthy or degraded (Kubernetes readiness probe).

Example

use stygian_graph::application::health::{HealthReporter, HealthStatus};

let mut r = HealthReporter::new();
r.register("db", HealthStatus::Healthy);
assert!(r.report().is_ready());

pub fn is_live(&self) -> bool

Returns true while the process should continue running.

The process is considered alive unless every component is unhealthy (Kubernetes liveness probe).

Example

use stygian_graph::application::health::{HealthReporter, HealthStatus};

let r = HealthReporter::new();
r.register("db", HealthStatus::Unhealthy("disk full".into()));
r.register("cache", HealthStatus::Healthy);
// One unhealthy component doesn't kill the process while others are healthy
assert!(r.report().is_live());

pub fn http_status_code(&self) -> u16

HTTP status code suitable for a health-check endpoint.

Returns 200 when ready, 503 when not.

Example

use stygian_graph::application::health::{HealthReporter, HealthStatus};

let mut r = HealthReporter::new();
r.register("db", HealthStatus::Healthy);
assert_eq!(r.report().http_status_code(), 200u16);

Trait Implementations

impl Clone for HealthReport

fn clone(&self) -> HealthReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HealthReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HealthReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.