Skip to main content

run_health_command

Function run_health_command 

Source
pub async fn run_health_command(
    config_path: &Path,
    check_type: &str,
    verbose: bool,
) -> Result<(), Box<dyn Error>>
Expand description

Run the health CLI command.

Performs real health checks against the server’s internal state and the external services it depends on (docs.rs, crates.io), then prints a report.

Returns an error (so the process exits with a non-zero status) when the overall status is not healthy. This makes the command usable as a container or orchestrator health probe (e.g. the Docker Compose healthcheck).

Recognized check_type values: all, external, internal, docs_rs, crates_io. Unknown values produce a degraded (non-healthy) report.