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

#[doc(hidden)]
#[macro_export]
macro_rules! span_inner {
    ($args:expr, $block:expr) => {{
        let span = async_log::Span::new($args);
        let res = $block;
        drop(span);
        res
    }};
}

/// Create a tracing span.
///
/// Spans are pairs of `trace!` logs. Every `span` wraps a block, and logs a message at the start,
/// of the block and a message after the block has finished. This works in asynchronous contexts
/// too.
///
/// Each span takes a `name`, a block, and optionally a list of key-value pairs in between those.
/// Once structured logging becomes part of `log` (currently feature gated as `kv_unstable`), we'll
/// move to support arbitrary key-value pairs.
///
/// Because of the way this macro is constructed, we currently support up to 9 key-value pairs.
/// Which makes a total of 12 arguments.
///
/// ## Examples
/// ```
/// use async_log::span;
/// use log::info;
///
/// span!("main", {
///     let x = "foo";
///     info!("this {}", x);
///
///     span!("inner, x={}", x, {
///         info!("we must go deeper {}", x);
///     });
/// })
/// ```
#[macro_export]
macro_rules! span {
    ($args:expr, $block:expr) => {{
        async_log::span_inner!($args, $block)
    }};
    ($args:expr, $a:expr, $block:expr) => {{
        let args = format!($args, $a);
        async_log::span_inner!(args, $block)
    }};
    ($args:expr, $a:expr, $b:expr, $block:expr) => {{
        let args = format!($args, $a, $b);
        async_log::span_inner!(args, $block)
    }};
    ($args:expr, $a:expr, $b:expr, $c:expr, $block:expr) => {{
        let args = format!($args, $a, $b, $c);
        async_log::span_inner!(args, $block)
    }};
    ($args:expr, $a:expr, $b:expr, $c:expr, $d:expr, $block:expr) => {{
        let args = format!($args, $a, $b, $c, $d);
        async_log::span_inner!(args, $block)
    }};
    ($args:expr, $a:expr, $b:expr, $c:expr, $d:expr, $e:expr, $block:expr) => {{
        let args = format!($args, $a, $b, $c, $d, $e);
        async_log::span_inner!(args, $block)
    }};
    ($args:expr, $a:expr, $b:expr, $c:expr, $d:expr, $e:expr, $f:expr, $block:expr) => {{
        let args = format!($args, $a, $b, $c, $d, $e, $f);
        async_log::span_inner!(args, $block)
    }};
    ($args:expr, $a:expr, $b:expr, $c:expr, $d:expr, $e:expr, $f:expr, $g:expr, $block:expr) => {{
        let args = format!($args, $a, $b, $c, $d, $e, $f, $g);
        async_log::span_inner!(args, $block)
    }};
}