ferrokinesis 0.7.0

A local AWS Kinesis mock server for testing, written in Rust
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

//! Health check endpoints for the Kinesis emulator.
//!
//! Three endpoints are registered by [`crate::create_app`]:
//! - `GET /_health` — aggregated status with component breakdown ([`health`])
//! - `GET /_health/live` — liveness probe, always 200 if the server is up ([`live`])
//! - `GET /_health/ready` — readiness probe, checks store connectivity ([`ready`])

use axum::extract::State;
use axum::http::StatusCode;
use axum::http::header;
use axum::response::{IntoResponse, Response};
use serde_json::json;

use crate::store::Store;

/// `GET /_health` — aggregated health with JSON component breakdown.
pub async fn health(State(store): State<Store>) -> Response {
    match store.check_ready() {
        Ok(()) => (
            StatusCode::OK,
            axum::Json(json!({
                "status": "UP",
                "components": {
                    "store": { "status": "UP" }
                }
            })),
        )
            .into_response(),
        Err(err) => (
            StatusCode::SERVICE_UNAVAILABLE,
            axum::Json(json!({
                "status": "DOWN",
                "components": {
                    "store": { "status": "DOWN", "detail": err.to_string() }
                }
            })),
        )
            .into_response(),
    }
}

/// `GET /_health/live` — liveness probe, always succeeds if the server is up.
pub async fn live() -> (StatusCode, &'static str) {
    (StatusCode::OK, "OK")
}

/// `GET /_health/ready` — readiness probe, checks store connectivity.
pub async fn ready(State(store): State<Store>) -> (StatusCode, &'static str) {
    match store.check_ready() {
        Ok(()) => (StatusCode::OK, "OK"),
        Err(_) => (StatusCode::SERVICE_UNAVAILABLE, "Service Unavailable"),
    }
}

/// `GET /metrics` - Prometheus text-format metrics.
pub async fn metrics(State(store): State<Store>) -> Response {
    (
        StatusCode::OK,
        [(
            header::CONTENT_TYPE,
            "text/plain; version=0.0.4; charset=utf-8",
        )],
        store.render_metrics().await,
    )
        .into_response()
}