Struct InFlightRequestsCounter

pub struct InFlightRequestsCounter { /* private fields */ }

Available on crate feature metrics only.

An atomic counter that keeps track of the number of in-flight requests.

This will normally combined with InFlightRequestsLayer or InFlightRequests which will update the counter as requests arrive.

Implementations

impl InFlightRequestsCounter

pub fn new() -> Self

Create a new InFlightRequestsCounter.

pub fn get(&self) -> usize

Get the current number of in-flight requests.

pub async fn run_emitter<F, Fut>(self, interval: Duration, emit: F)

where F: FnMut(usize) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send,

Run a future every interval which receives the current number of in-flight requests.

This can be used to send the current count to your metrics system.

This function will loop forever so normally it is called with [tokio::spawn]:

use tower_http::metrics::in_flight_requests::InFlightRequestsCounter;
use std::time::Duration;

let counter = InFlightRequestsCounter::new();

tokio::spawn(
    counter.run_emitter(Duration::from_secs(10), |count: usize| async move {
        // Send `count` to metrics system.
    }),
);

Trait Implementations

impl Clone for InFlightRequestsCounter

fn clone(&self) -> InFlightRequestsCounter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InFlightRequestsCounter

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

Formats the value using the given formatter.

impl Default for InFlightRequestsCounter

fn default() -> InFlightRequestsCounter

Returns the “default value” for a type.