Struct actix_web_opentelemetry::RequestMetrics

pub struct RequestMetrics { /* private fields */ }

Available on crate feature metrics only.

Request metrics tracking

Examples

use actix_web::{dev, http, web, App, HttpRequest, HttpServer};
use actix_web_opentelemetry::{
    PrometheusMetricsHandler,
    RequestMetricsBuilder,
    RequestTracing,
};
use opentelemetry::{
    global,
    sdk::{
        export::metrics::aggregation,
        metrics::{controllers, processors, selectors},
        propagation::TraceContextPropagator,
    },
};

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    // Request metrics middleware
    let meter = global::meter("actix_web");
    let request_metrics = RequestMetricsBuilder::new().build(meter);

    // Prometheus request metrics handler
    let controller = controllers::basic(
        processors::factory(
            selectors::simple::histogram([1.0, 2.0, 5.0, 10.0, 20.0, 50.0]),
            aggregation::cumulative_temporality_selector(),
        )
        .with_memory(true),
    )
    .build();
    let exporter = opentelemetry_prometheus::exporter(controller).init();
    let metrics_handler = PrometheusMetricsHandler::new(exporter);

    // Run actix server, metrics are now available at http://localhost:8080/metrics
    HttpServer::new(move || {
        App::new()
            .wrap(RequestTracing::new())
            .wrap(request_metrics.clone())
            .route("/metrics", web::get().to(metrics_handler.clone()))
    })
    .bind("localhost:8080")?
    .run()
    .await
}

Trait Implementations

impl Clone for RequestMetrics

fn clone(&self) -> RequestMetrics

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S, B> Transform<S, ServiceRequest> for RequestMetricswhere
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static,
    B: 'static,

type Response = ServiceResponse<B>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = RequestMetricsMiddleware<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<RequestMetrics as Transform<S, ServiceRequest>>::Transform, <RequestMetrics as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously