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

use crate::RootSpan;
use pavex::middleware::Next;
use pavex::response::Response;
use std::future::IntoFuture;
use tracing::Instrument;

/// A logging middleware that instruments the request processing pipeline with
/// [`RootSpan`].  
/// All `tracing` spans entered after `logger` executes will be children of [`RootSpan`],
/// either directly or transitively.
///
/// # Registration
///
/// Use [`Blueprint::wrap`] to register `logger` as a middleware:
///
/// ```rust
/// use pavex::blueprint::Blueprint;
/// use pavex::f;
///
/// let mut bp = Blueprint::new();
/// bp.wrap(f!(pavex_tracing::logger));
/// ```
///
/// You will also need to register a constructor for [`RootSpan`].
/// Check out its documentation for more information.
///
/// [`Blueprint::wrap`]: pavex::blueprint::Blueprint::wrap
pub async fn logger<C>(root_span: RootSpan, next: Next<C>) -> Response
where
    C: IntoFuture<Output = Response>,
{
    next.into_future().instrument(root_span.into_inner()).await
}