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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
use std::task::Context;
use std::task::Poll;
use std::time::Duration;
use std::time::Instant;

use actix_service::Service;
use actix_service::Transform;
use actix_web::dev::Factory;
use actix_web::dev::ServiceRequest;
use actix_web::dev::ServiceResponse;
use actix_web::Error;
use actix_web::HttpRequest;
use actix_web::HttpResponse;
use actix_web::Responder;
use futures::future::ok;
use futures::future::ready;
use futures::future::Ready;
use prometheus::CounterVec;
use prometheus::Encoder;
use prometheus::HistogramOpts;
use prometheus::HistogramVec;
use prometheus::Opts;
use prometheus::Registry;
use prometheus::TextEncoder;
use slog::debug;
use slog::Logger;

/// Set of metrics tracked by the `MetricsMiddleware` for actix web.
#[derive(Clone)]
pub struct MetricsCollector {
    duration: HistogramVec,
    errors: CounterVec,
}

impl MetricsCollector {
    /// Create a new set of metrics with the given prefix.
    pub fn new<S>(prefix: S) -> MetricsCollector
    where
        S: AsRef<str>,
    {
        let prefix = prefix.as_ref();
        let duration = HistogramVec::new(
            HistogramOpts::new(
                format!("{}_endpoint_duration", prefix).as_str(),
                "Duration (in seconds) of HTTP endpoints",
            ),
            &["method", "path", "status"],
        )
        .expect("unable to configure API duration histogram");
        let errors = CounterVec::new(
            Opts::new(
                format!("{}_endpoint_errors", prefix).as_str(),
                "Number of errors encountered while handling requests",
            ),
            &["method", "path", "status"],
        )
        .expect("unable to configure API errors counter");
        MetricsCollector { duration, errors }
    }

    /// Register this set of metrics with the registry.
    pub fn register(&self, logger: &Logger, registry: &Registry) {
        if let Err(error) = registry.register(Box::new(self.duration.clone())) {
            debug!(logger, "Failed to register MetricsMiddleware::duration"; "error" => ?error);
        }
        if let Err(error) = registry.register(Box::new(self.errors.clone())) {
            debug!(logger, "Failed to register MetricsMiddleware::errors"; "error" => ?error);
        }
    }
}

/// ActixWeb `Responder` to export prometheus metrics.
#[derive(Clone)]
pub struct MetricsExporter {
    registry: Registry,
}

impl MetricsExporter {
    pub fn factory(registry: Registry) -> MetricsExporter {
        MetricsExporter { registry }
    }
}

impl Factory<(), Ready<MetricsExporter>, MetricsExporter> for MetricsExporter {
    fn call(&self, _: ()) -> Ready<MetricsExporter> {
        let registry = self.registry.clone();
        ready(MetricsExporter { registry })
    }
}

impl Responder for MetricsExporter {
    type Error = Error;
    type Future = Ready<Result<HttpResponse, Error>>;

    fn respond_to(self, _: &HttpRequest) -> Self::Future {
        let mut buffer = Vec::new();
        let encoder = TextEncoder::new();
        let metric_familys = self.registry.gather();
        encoder.encode(&metric_familys, &mut buffer).unwrap();
        let response = HttpResponse::Ok()
            .header(actix_web::http::header::CONTENT_TYPE, encoder.format_type())
            .body(buffer);
        ok(response)
    }
}

/// Actix Web middleware to capture request metrics.
pub struct MetricsMiddleware {
    metrics: MetricsCollector,
}

impl MetricsMiddleware {
    pub fn new(metrics: MetricsCollector) -> MetricsMiddleware {
        MetricsMiddleware { metrics }
    }
}

// `S` - type of the next service
// `B` - type of response's body
impl<S, B> Transform<S> for MetricsMiddleware
where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static,
    B: 'static,
{
    type Request = ServiceRequest;
    type Response = ServiceResponse<B>;
    type Error = Error;
    type InitError = ();
    type Transform = MiddlewareService<S>;
    type Future = Ready<Result<Self::Transform, Self::InitError>>;

    fn new_transform(&self, service: S) -> Self::Future {
        ok(MiddlewareService {
            metrics: self.metrics.clone(),
            service,
        })
    }
}

/// Inner middleware to process requests on behalf of `MetricsMiddleware`.
pub struct MiddlewareService<S> {
    metrics: MetricsCollector,
    service: S,
}

impl<S, B> Service for MiddlewareService<S>
where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static,
    B: 'static,
{
    type Request = ServiceRequest;
    type Response = ServiceResponse<B>;
    type Error = Error;
    type Future = crate::BoxedFuture<Self::Response, Self::Error>;

    fn poll_ready(&mut self, ctx: &mut Context) -> Poll<Result<(), Self::Error>> {
        self.service.poll_ready(ctx)
    }

    fn call(&mut self, req: ServiceRequest) -> Self::Future {
        let metrics = self.metrics.clone();
        let request_start = Instant::now();
        let response = self.service.call(req);
        Box::pin(async move {
            let response = response.await?;
            let duration = duration_to_seconds(request_start.elapsed());
            let method = response.request().method().as_str();
            let path = response.request().path();
            let status = response.response().status();
            metrics
                .duration
                .with_label_values(&[method, path, status.as_str()])
                .observe(duration);
            if response.response().error().is_some() {
                metrics
                    .errors
                    .with_label_values(&[method, path, status.as_str()])
                    .inc();
            }
            Ok(response)
        })
    }
}

/// Convert a [request] duration to seconds.
fn duration_to_seconds(duration: Duration) -> f64 {
    let nanos = f64::from(duration.subsec_nanos()) / 1e9;
    duration.as_secs() as f64 + nanos
}

#[cfg(test)]
mod tests {
    use actix_web::http::StatusCode;
    use actix_web::test::call_service;
    use actix_web::test::init_service;
    use actix_web::test::TestRequest;
    use actix_web::web;
    use actix_web::App;
    use prometheus::Registry;

    use super::MetricsExporter;

    #[actix_rt::test]
    async fn metrics_exporter_returns_200() {
        let registry = Registry::new();
        let exporter = MetricsExporter::factory(registry);
        let service = web::resource("/").to(exporter);
        let mut app = init_service(App::new().service(service)).await;
        let request = TestRequest::with_uri("https://server:1234/").to_request();
        let response = call_service(&mut app, request).await;
        assert_eq!(response.status(), StatusCode::OK);
    }
}