Struct actix_web_prom::PrometheusMetrics

#[must_use = "must be set up as middleware for actix-web"]
pub struct PrometheusMetrics {
    pub registry: Registry,
    // some fields omitted
}

By default two metrics are tracked (this assumes the namespace actix_web_prom):

• actix_web_prom_http_requests_total (labels: endpoint, method, status): the total number of HTTP requests handled by the actix HttpServer.

• actix_web_prom_http_requests_duration_seconds (labels: endpoint, method, status): the request duration for all HTTP requests handled by the actix HttpServer.

Fields

registry: Registry

exposed registry for custom prometheus metrics

Methods

impl PrometheusMetrics

pub fn new(namespace: &str, endpoint: &str) -> Self

Create a new PrometheusMetrics. You set the namespace and the metrics endpoint through here.

Trait Implementations

impl Clone for PrometheusMetrics

fn clone(&self) -> PrometheusMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, B> Transform<S> for PrometheusMetrics where
    B: MessageBody,
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    S::Future: 'static, 

type Request = ServiceRequest

Requests handled by the service.

type Response = ServiceResponse<StreamLog<B>>

Responses given by the service.

type Error = Error

Errors produced by the service.

type InitError = ()

Errors produced while building a service.

type Transform = PrometheusMetricsMiddleware<S>

The TransformService value created by this factory

type Future = FutureResult<Self::Transform, Self::InitError>

The future response value.

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

Creates and returns a new Service component, asynchronously

fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> where
    F: Fn(Self::InitError) -> E, 

Map this service's factory error to a different error, returning a new transform service factory.

fn from_err<E>(self) -> TransformFromErr<Self, S, E> where
    E: From<Self::InitError>, 

Map this service's init error to any error implementing From for this services Error`.