hotfix-status

Crates.iohotfix-status
lib.rshotfix-status
version0.1.6
created_at2025-09-08 09:37:21.76282+00
updated_at2025-09-24 08:26:29.436795+00
descriptionStatus endpoints and an optional web-based dashboard for the HotFIX engine
homepagehttps://github.com/Validus-Risk-Management/hotfix
repositoryhttps://github.com/Validus-Risk-Management/hotfix
max_upload_size
id1829048
size334,910
David Steiner (davidsteiner)

documentation

README

hotfix-status

Status APIs and UI for the HotFIX engine.

This crate is an add-on for the HotFIX engine to provide useful APIs about the FIX session state and health.

Optionally, it also provides a web-based UI to view and manage the session state.

Usage

hotfix-status build an axum router you can embed in your application in any way you like.

To build the router, just call build_router with the HotFIX session ref:

...

use hotfix_status::build_router;

...

async fn start_status_service(session_ref: SessionRef<Message>) {
    let status_router = build_router(session_ref);
    let host_and_port = std::env::var("HOST_AND_PORT").unwrap_or("0.0.0.0:9881".to_string());
    let listener = tokio::net::TcpListener::bind(&host_and_port).await.unwrap();

    info!("starting status service on http://{host_and_port}");
    axum::serve(listener, status_router).await.unwrap();
}

For a full example, check out the simple-new-order sample application.

Commit count: 325

cargo fmt