prom_remote_api/
lib.rs

1//! Prometheus [remote storage](https://prometheus.io/docs/prometheus/latest/storage/#remote-storage-integrations) API
2//!
3//! This crate provides:
4//! - Rust-binding to [prometheus remote storage protocol buffer definitions](https://github.com/prometheus/prometheus/blob/main/prompb/remote.proto).
5//!
6//!   Any third-party storage can integrate with Prometheus by implementing [RemoteStorage](crate::types::RemoteStorage) trait.
7//! - Various web framework utils to serve the remote wire protocols, which are controlled by corresponding feature-gates.
8//!   - [Warp](https://github.com/seanmonstar/warp)
9//!   - [Actix](https://actix.rs/)
10//!   - More web framework will be added
11//!
12//!
13//! See [warp-demo.rs](https://github.com/jiacai2050/prom-remote-api/blob/main/examples/warp-demo.rs), [actix-demo.rs](https://github.com/jiacai2050/prom-remote-api/blob/main/examples/actix-demo.rs) to learn how to build a remote storage.
14//!
15
16pub mod types;
17mod util;
18pub mod web;