instrument-level 1.0.12

A Rust procedural macro collection providing convenient tracing instrumentation macros for different log levels (trace, debug, info, warn, error). This crate simplifies the process of adding tracing spans to functions with pre-configured log levels.
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
100
101
102
103
104

use crate::*;

/// Macro for adding trace-level instrumentation to functions.
///
/// This macro instruments functions with trace-level logging and automatically includes `skip_all`
/// to exclude all function arguments from the span fields.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The function to instrument
///
/// # Returns
///
/// - `TokenStream` - The instrumented function with trace-level logging and skip_all enabled
pub(crate) fn instrument_trace_macro(attr: TokenStream, item: TokenStream) -> TokenStream {
    let input_fn: ItemFn = parse_macro_input!(item as ItemFn);
    let params: TokenStream2 = attr.into();
    let expanded: TokenStream2 = quote! {
        #[::tracing::instrument(level = "trace", skip_all, #params)]
        #input_fn
    };
    TokenStream::from(expanded)
}

/// Macro for adding debug-level instrumentation to functions.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The function to instrument
///
/// # Returns
///
/// - `TokenStream` - The instrumented function with debug-level logging
pub(crate) fn instrument_debug_macro(attr: TokenStream, item: TokenStream) -> TokenStream {
    let input_fn: ItemFn = parse_macro_input!(item as ItemFn);
    let params: TokenStream2 = attr.into();
    let expanded: TokenStream2 = quote! {
        #[::tracing::instrument(level = "debug", #params)]
        #input_fn
    };
    TokenStream::from(expanded)
}

/// Macro for adding info-level instrumentation to functions.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The function to instrument
///
/// # Returns
///
/// - `TokenStream` - The instrumented function with info-level logging
pub(crate) fn instrument_info_macro(attr: TokenStream, item: TokenStream) -> TokenStream {
    let input_fn: ItemFn = parse_macro_input!(item as ItemFn);
    let params: TokenStream2 = attr.into();
    let expanded: TokenStream2 = quote! {
        #[::tracing::instrument(level = "info", #params)]
        #input_fn
    };
    TokenStream::from(expanded)
}

/// Macro for adding warn-level instrumentation to functions.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The function to instrument
///
/// # Returns
///
/// - `TokenStream` - The instrumented function with warn-level logging
pub(crate) fn instrument_warn_macro(attr: TokenStream, item: TokenStream) -> TokenStream {
    let input_fn: ItemFn = parse_macro_input!(item as ItemFn);
    let params: TokenStream2 = attr.into();
    let expanded: TokenStream2 = quote! {
        #[::tracing::instrument(level = "warn", #params)]
        #input_fn
    };
    TokenStream::from(expanded)
}

/// Macro for adding error-level instrumentation to functions.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The function to instrument
///
/// # Returns
///
/// - `TokenStream` - The instrumented function with error-level logging
pub(crate) fn instrument_error_macro(attr: TokenStream, item: TokenStream) -> TokenStream {
    let input_fn: ItemFn = parse_macro_input!(item as ItemFn);
    let params: TokenStream2 = attr.into();
    let expanded: TokenStream2 = quote! {
        #[::tracing::instrument(level = "error", #params)]
        #input_fn
    };
    TokenStream::from(expanded)
}