10 releases
0.1.9 | Sep 26, 2024 |
---|---|
0.1.8 | Sep 24, 2024 |
0.1.4 | Jun 17, 2024 |
#317 in Profiling
1,180 downloads per month
Used in comprehensive
17KB
240 lines
Tonic Prometheus Layer
A lightweight Prometheus metrics layer for Tonic gRPC Server inspired by autometrics
It provides the following metrics:
grpc_server_handled_total
: a Counter for tracking the total number of completed gRPC calls.grpc_server_started_total
: a Counter for tracking the total number of gRPC calls started. The difference between this andgrpc_server_handled_total
equals the number of ongoing requests.grpc_server_handling_seconds
: a Histogram for tracking gRPC call duration.
Usage
Add tonic_prometheus_layer
to your Cargo.toml
.
[dependencies]
tonic_prometheus_layer = "0.1.9"
Then add a new layer to your tonic instance like:
use std::net::SocketAddr;
use std::str::FromStr;
use rocket::{get, routes};
use rocket::http::Status;
use rocket::response::content::RawText;
use rocket::config::Shutdown;
use rocket::response::status::Custom;
use tonic_prometheus_layer::metrics::GlobalSettings;
use crate::api::server;
use crate::proto::service_server::ServiceServer;
mod api;
mod proto;
#[tokio::main]
async fn main() {
let addr: SocketAddr = "127.0.0.1:9090".parse().unwrap();
let service = server::Server {};
tonic_prometheus_layer::metrics::try_init_settings(GlobalSettings {
histogram_buckets: vec![0.01, 0.05, 0.1, 0.5, 1.0, 2.5, 5.0, 10.0],
..Default::default()
}).unwrap();
let metrics_layer = tonic_prometheus_layer::MetricsLayer::new();
tokio::spawn(async {
run_http_server("127.0.0.1:8090").await
});
tonic::transport::Server::builder()
.layer(metrics_layer)
.add_service(ServiceServer::new(service))
.serve(addr.into())
.await
.unwrap();
}
#[get("/metrics")]
async fn metrics() -> Custom<RawText<String>> {
let body = tonic_prometheus_layer::metrics::encode_to_string().unwrap();
Custom(Status::Ok, RawText(body))
}
pub async fn run_http_server(addr: &str) {
let addr = SocketAddr::from_str(addr).unwrap();
let config = rocket::config::Config {
address: addr.ip(),
port: addr.port(),
shutdown: Shutdown {
ctrlc: false,
..Default::default()
},
..rocket::config::Config::release_default()
};
rocket::custom(config)
.mount("/", routes![metrics])
.launch()
.await
.unwrap();
}
Dependencies
~7–14MB
~168K SLoC