Expand description
Channel monitoring - expose channel data via HTTP JSON APIs Monitoring system for SV2 applications.
Provides HTTP JSON API and Prometheus metrics for monitoring. Read-only - does not modify any state.
§Architecture
- Server: The upstream connection (pool, JDS) - typically one per app
- Clients: Downstream connections (miners) - multiple per app
- SV1 clients: Legacy SV1 connections (Translator only)
Re-exports§
pub use client::ExtendedChannelInfo;pub use client::StandardChannelInfo;pub use client::Sv2ClientInfo;pub use client::Sv2ClientMetadata;pub use client::Sv2ClientsMonitoring;pub use client::Sv2ClientsSummary;pub use http_server::ErrorResponse;pub use http_server::HealthResponse;pub use http_server::MonitoringServer;pub use http_server::RootResponse;pub use http_server::ServerChannelsResponse;pub use http_server::ServerResponse;pub use http_server::Sv1ClientsResponse;pub use http_server::Sv2ClientChannelsResponse;pub use http_server::Sv2ClientResponse;pub use http_server::Sv2ClientsResponse;pub use server::ServerExtendedChannelInfo;pub use server::ServerInfo;pub use server::ServerMonitoring;pub use server::ServerStandardChannelInfo;pub use server::ServerSummary;pub use snapshot_cache::MonitoringSnapshot;pub use snapshot_cache::SnapshotCache;pub use sv1::Sv1ClientInfo;pub use sv1::Sv1ClientsMonitoring;pub use sv1::Sv1ClientsSummary;
Modules§
- client
- Sv2 client monitoring types
- http_
server - HTTP server for exposing monitoring data using Axum
- prometheus_
metrics - Prometheus metrics definitions for SV2 monitoring
- routes
- Canonical path constants and helpers for the monitoring HTTP API.
- server
- Server monitoring types
- snapshot_
cache - Snapshot cache for monitoring data
- sv1
- SV1 client monitoring types
Structs§
- Global
Info - Global statistics from
/api/v1/globalendpoint