Umbral Health

Every load balancer and orchestrator asks the same two questions: are you alive, and are you ready for traffic? Umbral Health answers both with zero config — a liveness probe and a readiness probe that actually checks the database is reachable, not just that the process is running. Mount the plugin and your deploy target stops guessing whether to route to this instance.

Install

cargo add umbral-health

Wire it up

use umbral::prelude::*;
use umbral_health::HealthPlugin;

let app = App::builder()
    .database("default", pool)
    .plugin(HealthPlugin::default())   // /healthz + /ready
    .build()?;

Target: gate readiness on a dependency

Add your own check — a cache ping, a queue connection — and /ready only reports green when it passes.

use umbral_health::HealthPlugin;
use std::time::Duration;

HealthPlugin::default()
    .check(RedisPing)                       // your HealthCheck impl
    .check_timeout(Duration::from_secs(2)); // fail fast, don't hang the probe

What you get

• /healthz liveness probe (is the process up?)
• /ready readiness probe that verifies the DB is reachable
• Pluggable custom HealthChecks for your own dependencies
• Per-check timeouts so a hung dependency doesn't hang the probe
• Zero config to start — mount and deploy