rocket_health

🔧 Drop-in /health route for Rocket APIs with uptime and rolling average latency metrics.

✨ Features

• 🚀 Easy integration into any Rocket API
• 📈 Tracks server uptime
• ⚡ Measures average response latency (rolling window)
• 📤 Exposes /health route returning structured JSON

Example response:

{
  "status": "ok",
  "uptime_seconds": 432.123,
  "mean_latency_seconds": 0.0054
}

📦 Installation

Add to your Cargo.toml:

[dependencies]
rocket_health = "0.1"
rocket = { version = "0.5", features = ["json"] }

🚀 Usage

Step 1: Mount health route and fairing

#[macro_use] extern crate rocket;
use rocket_health::mount_health_route;

#[launch]
fn rocket() -> _ {
    let rocket = rocket::build();
    mount_health_route(rocket)
}

Step 2: Start your Rocket app

The /health route is now available:

GET /health

Returns uptime and latency in seconds (float). Latency is computed using a sliding window of the last 100 requests.

🧪 Testing

You can unit test the handler or compute test coverage using cargo-tarpaulin:

cargo install cargo-tarpaulin
cargo tarpaulin --out Html --ignore-tests --line --target-dir tarpaulin-target/ --skip-clean