tonic_prometheus_layer 0.3.0

Tonic-compatible Tower Layer for Prometheus Metrics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# tonic_prometheus_layer



## 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`.
```not_rust
[dependencies]
tonic_prometheus_layer = "0.3.0"
```

### Server Instrumentation

Add a new layer to your tonic instance:
```rust
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:

```rust
#[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);
}
```

License: MIT