rocket_health 0.2.0

Drop-in /health route for Rocket APIs with uptime and rolling average latency metrics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# rocket_health

> 🔧 Drop-in `/health` route for [Rocket](https://rocket.rs) APIs with uptime and rolling average latency metrics.

[![Crates.io](https://img.shields.io/crates/v/rocket_health.svg)](https://crates.io/crates/rocket_health)
[![Docs.rs](https://docs.rs/rocket_health/badge.svg)](https://docs.rs/rocket_health)
[![CI](https://github.com/juliengriffoul/rocket_health/actions/workflows/build.yml/badge.svg)](https://github.com/juliengriffoul/rocket_health/actions)

---

## ✨ Features

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

Example response:

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

---

## 📦 Installation

Add to your `Cargo.toml`:

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

---

## 🚀 Usage

### Step 1: Mount health route and fairing

```rust
#[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`](https://github.com/xd009642/tarpaulin):

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