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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

//! 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.

mod r#fn;

use r#fn::*;

use {proc_macro::TokenStream, proc_macro2::TokenStream as TokenStream2, quote::quote, syn::*};

/// Enables trace-level instrumentation for the decorated function.
///
/// This attribute macro wraps the function with `#[::tracing::instrument(level = "trace", skip_all)]`,
/// enabling automatic tracing instrumentation at the trace level with all arguments excluded from span fields.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The TokenStream representing the function to be instrumented.
///
/// # Returns
///
/// Returns the expanded TokenStream with tracing instrumentation applied.
///
/// # Examples
///
/// ```
/// use tracing;
/// use instrument_level::*;
///
/// #[instrument_trace]
/// async fn test(x: i32, y: i32) -> i32 {
///     x + y
/// }
/// ```
#[proc_macro_attribute]
pub fn instrument_trace(attr: TokenStream, item: TokenStream) -> TokenStream {
    instrument_trace_macro(attr, item)
}

/// Enables debug-level instrumentation for the decorated function.
///
/// This attribute macro wraps the function with `#[::tracing::instrument(level = "debug")]`,
/// enabling automatic tracing instrumentation at the debug level.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The TokenStream representing the function to be instrumented.
///
/// # Returns
///
/// Returns the expanded TokenStream with tracing instrumentation applied.
///
/// # Examples
///
/// ```
/// use tracing;
/// use instrument_level::*;
///
/// #[instrument_debug]
/// async fn test(x: i32, y: i32) -> i32 {
///     x + y
/// }
///
/// #[instrument_debug(skip_all)]
/// async fn test_skip_all(x: i32, y: i32) -> i32 {
///     x + y
/// }
/// ```
#[proc_macro_attribute]
pub fn instrument_debug(attr: TokenStream, item: TokenStream) -> TokenStream {
    instrument_debug_macro(attr, item)
}

/// Enables info-level instrumentation for the decorated function.
///
/// This attribute macro wraps the function with `#[::tracing::instrument(level = "info")]`,
/// enabling automatic tracing instrumentation at the info level.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The TokenStream representing the function to be instrumented.
///
/// # Returns
///
/// Returns the expanded TokenStream with tracing instrumentation applied.
///
/// # Examples
///
/// ```
/// use tracing;
/// use instrument_level::*;
///
/// #[instrument_info]
/// async fn test(x: i32, y: i32) -> i32 {
///     x + y
/// }
///
/// #[instrument_info(skip_all)]
/// async fn test_skip_all(x: i32, y: i32) -> i32 {
///     x + y
/// }
/// ```
#[proc_macro_attribute]
pub fn instrument_info(attr: TokenStream, item: TokenStream) -> TokenStream {
    instrument_info_macro(attr, item)
}

/// Enables warn-level instrumentation for the decorated function.
///
/// This attribute macro wraps the function with `#[::tracing::instrument(level = "warn")]`,
/// enabling automatic tracing instrumentation at the warn level.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The TokenStream representing the function to be instrumented.
///
/// # Returns
///
/// Returns the expanded TokenStream with tracing instrumentation applied.
///
/// # Examples
///
/// ```
/// use tracing;
/// use instrument_level::*;
///
/// #[instrument_warn]
/// async fn test(x: i32, y: i32) -> i32 {
///     x + y
/// }
///
/// #[instrument_warn(skip_all)]
/// async fn test_skip_all(x: i32, y: i32) -> i32 {
///     x + y
/// }
/// ```
#[proc_macro_attribute]
pub fn instrument_warn(attr: TokenStream, item: TokenStream) -> TokenStream {
    instrument_warn_macro(attr, item)
}

/// Enables error-level instrumentation for the decorated function.
///
/// This attribute macro wraps the function with `#[::tracing::instrument(level = "error")]`,
/// enabling automatic tracing instrumentation at the error level.
///
/// # Arguments
///
/// - `attr` - Additional tracing instrument parameters (optional): target, name, skip, fields, etc.
/// - `item` - The TokenStream representing the function to be instrumented.
///
/// # Returns
///
/// Returns the expanded TokenStream with tracing instrumentation applied.
///
/// # Examples
///
/// ```
/// use tracing;
/// use instrument_level::*;
///
/// #[instrument_error]
/// async fn test(x: i32, y: i32) -> i32 {
///     x + y
/// }
///
/// #[instrument_error(skip_all)]
/// async fn test_skip_all(x: i32, y: i32) -> i32 {
///     x + y
/// }
/// ```
#[proc_macro_attribute]
pub fn instrument_error(attr: TokenStream, item: TokenStream) -> TokenStream {
    instrument_error_macro(attr, item)
}