apalis 0.7.4

Simple, extensible multithreaded background job processing for Rust
Documentation 
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use apalis_core::request::Request;

use super::DEFAULT_MESSAGE_LEVEL;
use tracing::Level;
use tracing::Span;

/// Trait used to tell [`Trace`] what to do when a request is received.
///
/// See the [module docs](../trace/index.html#on_request) for details on exactly when the
/// `on_request` callback is called.
///
/// [`Trace`]: super::Trace
pub trait OnRequest<B, Ctx> {
    /// Do the thing.
    ///
    /// `span` is the `tracing` [`Span`], corresponding to this request, produced by the closure
    /// passed to [`TraceLayer::make_span_with`]. It can be used to [record field values][record]
    /// that weren't known when the span was created.
    ///
    /// [`Span`]: https://docs.rs/tracing/latest/tracing/span/index.html
    /// [record]: https://docs.rs/tracing/latest/tracing/span/struct.Span.html#method.record
    /// [`TraceLayer::make_span_with`]: crate::layers::tracing::TraceLayer::make_span_with
    fn on_request(&mut self, request: &Request<B, Ctx>, span: &Span);
}

impl<B, Ctx> OnRequest<B, Ctx> for () {
    #[inline]
    fn on_request(&mut self, _: &Request<B, Ctx>, _: &Span) {}
}

impl<B, F, Ctx> OnRequest<B, Ctx> for F
where
    F: FnMut(&Request<B, Ctx>, &Span),
{
    fn on_request(&mut self, request: &Request<B, Ctx>, span: &Span) {
        self(request, span)
    }
}

/// The default [`OnRequest`] implementation used by [`Trace`].
///
/// [`Trace`]: super::Trace
#[derive(Clone, Debug)]
pub struct DefaultOnRequest {
    level: Level,
}

impl Default for DefaultOnRequest {
    fn default() -> Self {
        Self {
            level: DEFAULT_MESSAGE_LEVEL,
        }
    }
}

impl DefaultOnRequest {
    /// Create a new `DefaultOnRequest`.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the [`Level`] used for [tracing events].
    ///
    /// Please note that while this will set the level for the tracing events
    /// themselves, it might cause them to lack expected information, like
    /// request method or path. You can address this using
    /// [`DefaultMakeSpan::level`].
    ///
    /// Defaults to [`Level::DEBUG`].
    ///
    /// [tracing events]: https://docs.rs/tracing/latest/tracing/#events
    /// [`DefaultMakeSpan::level`]: crate::layers::tracing::DefaultMakeSpan::level
    pub fn level(mut self, level: Level) -> Self {
        self.level = level;
        self
    }
}

impl<B, Ctx> OnRequest<B, Ctx> for DefaultOnRequest {
    fn on_request(&mut self, _: &Request<B, Ctx>, _: &Span) {
        match self.level {
            Level::ERROR => {
                tracing::event!(Level::ERROR, "task.start",);
            }
            Level::WARN => {
                tracing::event!(Level::WARN, "task.start",);
            }
            Level::INFO => {
                tracing::event!(Level::INFO, "task.start",);
            }
            Level::DEBUG => {
                tracing::event!(Level::DEBUG, "task.start",);
            }
            Level::TRACE => {
                tracing::event!(Level::TRACE, "task.start",);
            }
        }
    }
}