Lib.rs

Tonic Prometheus Layer

A lightweight Prometheus metrics layer for Tonic gRPC client and server

It provides the following metrics:

• grpc_server_handled_total: a Counter for tracking the total number of completed gRPC server calls.
• grpc_server_started_total: a Counter for tracking the total number of gRPC server calls started. The difference between this and grpc_server_handled_total equals the number of ongoing server requests.
• grpc_server_handling_seconds: a Histogram for tracking gRPC server call duration.
• grpc_client_handled_total: a Counter for tracking the total number of completed gRPC client calls.
• grpc_client_started_total: a Counter for tracking the total number of gRPC client calls started. The difference between this and grpc_client_handled_total equals the number of ongoing client requests.
• grpc_client_handling_seconds: a Histogram for tracking gRPC client call duration.

Usage

Add tonic_prometheus_layer to your Cargo.toml.

[dependencies]
tonic_prometheus_layer = "0.1.10"

Server Instrumentation

Add a new layer to your tonic instance:

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();
}

Client Instrumentation

Wrap each individual tonic client Channel object:

#[tokio::main]
async fn main() {
    let channel = tonic::transport::Channel::from_static("http://localhost")
        .connect()
        .await
        .unwrap();
    let channel = tonic_prometheus_layer::MetricsChannel::new(channel);
    let mut client = tonic_health::pb::health_client::HealthClient::new(channel);
}