Struct RequestMetrics

pub struct RequestMetrics { /* private fields */ }

Available on crate feature metrics only.

Request metrics tracking

For more information on how to configure Prometheus with OTLP

Examples

use actix_web::{http, web, App, HttpRequest, HttpResponse, HttpServer, Responder};
use opentelemetry::{global, KeyValue};
use opentelemetry_instrumentation_actix_web::{RequestMetrics, RequestTracing};
use opentelemetry_sdk::{metrics::SdkMeterProvider, Resource};

async fn manual_hello() -> impl Responder {
    HttpResponse::Ok().body("Hey there!")
}

#[actix_web::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize STDOUT exporter
    let exporter = opentelemetry_stdout::MetricExporter::default();

    // set up your meter provider with your exporter(s)
    let provider = SdkMeterProvider::builder()
        .with_periodic_exporter(exporter)
        .with_resource(
            // recommended attributes
            Resource::builder_empty()
                .with_attribute(KeyValue::new("service.name", "my_app"))
                .build(),
        )
        .build();
    global::set_meter_provider(provider.clone());

    // Run actix server, metrics will be exported periodically
    HttpServer::new(move || {
        App::new()
            .wrap(RequestTracing::new())
            .wrap(RequestMetrics::default())
            .route("/hey", web::get().to(manual_hello))
        })
        .bind("localhost:8080")?
        .run()
        .await?;

    //Shutdown the meter provider. This will trigger an export of all metrics.
    provider.shutdown()?;

    Ok(())
}

Implementations

impl RequestMetrics

pub fn builder() -> RequestMetricsBuilder

Create a builder to configure this middleware

Trait Implementations

impl Clone for RequestMetrics

fn clone(&self) -> RequestMetrics

Returns a duplicate 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 Default for RequestMetrics

fn default() -> Self

Returns the “default value” for a type.

impl<S, B> Transform<S, ServiceRequest> for RequestMetrics

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, S::Future: 'static, B: MessageBody + '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