Struct HealthChecker 

pub struct HealthChecker { /* private fields */ }

Health checker

Tracks the health of various server components, runs deep probes, maintains health history, and aggregates dependency health.

Implementations

impl HealthChecker

pub fn new() -> Self

Create a new health checker with default history capacity (10)

pub fn with_history_capacity(capacity: usize) -> Self

Create a new health checker with the given history capacity

pub fn set_status(&self, status: HealthStatus)

Set overall status

pub fn status(&self) -> HealthStatus

Get current overall status

pub fn set_storage_healthy(&self, healthy: bool)

Mark storage as healthy

pub fn set_network_healthy(&self, healthy: bool)

Mark network as healthy

pub fn set_cluster_enabled(&self, enabled: bool)

Mark cluster mode as enabled

pub fn set_cluster_healthy(&self, healthy: bool)

Mark cluster as healthy

pub fn uptime_seconds(&self) -> u64

Get uptime in seconds

pub fn is_alive(&self) -> bool

Check if server is alive (not shutting down or unhealthy). This is a lightweight check suitable for liveness probes.

pub fn is_ready(&self) -> bool

Check if server is ready to serve traffic. Returns false during startup, shutdown, and recovery.

pub fn liveness_response(&self) -> LivenessResponse

Build a liveness response (lightweight, fast)

pub fn readiness_response(&self) -> ReadinessResponse

Build a readiness response (includes component and dependency info)

pub fn register_probe( &self, name: impl Into<String>, probe: Arc<dyn DeepHealthCheck>, )

Register a deep health probe under the given name

pub async fn run_probes(&self) -> HashMap<String, HealthProbeResult>

Run all registered deep probes and return their results

pub fn register_dependency( &self, name: impl Into<String>, checker: Arc<dyn DeepHealthCheck>, )

Register a dependency health checker

pub async fn check_dependencies(&self) -> ProbeStatus

Run all dependency checks and update cached results. Returns the aggregated worst status.

pub fn aggregated_dependency_status(&self) -> ProbeStatus

Get the current aggregated dependency status (from cached results)

pub fn record_snapshot(&self)

Record a snapshot of the current health state into the history buffer

pub fn health_history(&self) -> Vec<HealthSnapshot>

Get the health check history as a chronologically ordered list

pub fn uptime_percent(&self) -> f64

Get the uptime percentage from the history buffer

pub fn get_health(&self) -> HealthCheckResponse

Get full health check response (enhanced with probes, deps, history)

pub async fn get_health_deep(&self) -> HealthCheckResponse

Get full health check response including deep probe results (async)

pub fn get_health_json(&self) -> Result<String, Error>

Format health as JSON

Trait Implementations

impl Clone for HealthChecker

fn clone(&self) -> HealthChecker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for HealthChecker

fn default() -> Self

Returns the “default value” for a type.