https://github.com/jiacai2050/prom-remote-api
Prometheus remote storage API for Rust
https://github.com/jiacai2050/prom-remote-api
prometheus prometheus-monitoring-solution remote-storage rust rust-api
Last synced: about 1 month ago
JSON representation
Prometheus remote storage API for Rust
- Host: GitHub
- URL: https://github.com/jiacai2050/prom-remote-api
- Owner: jiacai2050
- License: apache-2.0
- Created: 2023-01-15T12:58:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-27T12:16:55.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T07:56:54.483Z (about 2 months ago)
- Topics: prometheus, prometheus-monitoring-solution, remote-storage, rust, rust-api
- Language: Rust
- Homepage: https://crates.io/crates/prom-remote-api
- Size: 91.8 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prom-remote-api
[](https://crates.io/crates/prom-remote-api)
[](https://docs.rs/prom-remote-api)
[](https://github.com/jiacai2050/prom-remote-api/actions/workflows/ci.yml)
Prometheus [remote storage](https://prometheus.io/docs/prometheus/latest/storage/#remote-storage-integrations) API for Rust.
## Usage
There are two interfaces in Prometheus remote storage API: write/read.
Both interfaces use a snappy-compressed protocol buffer encoding over HTTP.
This crate provides:
- Rust-binding to [prometheus remote storage protocol buffer definitions](https://github.com/prometheus/prometheus/blob/main/prompb/remote.proto)
- Various web framework utils to serve the remote wire protocols, which are controlled by corresponding feature-gates. Available features:
- `warp`
- `actix`
- more web framework will be added
Any third-party storage can integrate with Prometheus by implementing `RemoteStorage` trait.
```rust
pub trait RemoteStorage: Sync {
type Err: Send;
type Context: Send + Sync;
/// Write samples to remote storage.
async fn write(&self, ctx: Self::Context, req: WriteRequest) -> Result<(), Self::Err>;
/// Process one query within [ReadRequest](crate::types::ReadRequest).
///
/// Note: Prometheus remote protocol sends multiple queries by default,
/// use [read](crate::types::RemoteStorage::read) to serve ReadRequest.
async fn process_query(
&self,
ctx: &Self::Context,
q: Query,
) -> Result;
/// Read samples from remote storage.
///
/// [ReadRequest](crate::types::ReadRequest) may contain more than one sub [queries](crate::types::Query).
async fn read(
&self,
ctx: Self::Context,
req: ReadRequest,
) -> Result {
let results = futures::future::join_all(
req.queries
.into_iter()
.map(|q| async { self.process_query(&ctx, q).await }),
)
.await
.into_iter()
.collect::, Self::Err>>()?;
Ok(ReadResponse { results })
}
}
```
See [warp-demo.rs](examples/warp-demo.rs), [actix-demo.rs](examples/actix-demo.rs) to learn how to build a remote storage.