f5aac47f68
## Motivation Currently, `tracing-attributes` consists of one very large `lib.rs` module that's 1358 lines long. In my opinion, this makes the code somewhat hard to navigate. ## Solution This branch refactors `tracing-attributes` so that most of the code is split into two separate modules: `attrs.rs`, which contains the types representing the attribute arguments and the code for parsing them, and `expand.rs`, which contains the code for actually expanding an `#[instrument]` macro to generate the instrumented code. For the most part, this was a pretty clean split. I also did a small change to the way `async-trait` support is implemented; moving the two steps for generating instrumented code for `async-trait` to two methods on the `AsyncTraitInfo` struct; one for determining if the instrumented function is also an `async-trait` method and finding the necessary information to instrument it, and one for generating the instrumented code. This feels a bit neater than doing all of that in the `gen_function` function. There shouldn't be any functional changes or significant implementatation changes (besides the `async-trait` change) in this branch; just moving code around. Signed-off-by: Eliza Weisman <eliza@buoyant.io>
tracing-attributes
Macro attributes for application-level tracing.
Overview
tracing is a framework for instrumenting Rust programs to collect
structured, event-based diagnostic information. This crate provides the
#[instrument] attribute for automatically instrumenting functions using
tracing.
Note that this macro is also re-exported by the main tracing crate.
Compiler support: requires rustc 1.42+
Usage
First, add this to your Cargo.toml:
[dependencies]
tracing-attributes = "0.1.18"
This crate provides the #[instrument] attribute for instrumenting a function
with a tracing span. For example:
use tracing_attributes::instrument;
#[instrument]
pub fn my_function(my_arg: usize) {
// ...
}
Supported Rust Versions
Tracing is built against the latest stable release. The minimum supported version is 1.42. The current Tracing version is not guaranteed to build on Rust versions earlier than the minimum supported version.
Tracing follows the same compiler support policies as the rest of the Tokio project. The current stable Rust compiler and the three most recent minor versions before it will always be supported. For example, if the current stable compiler version is 1.45, the minimum supported version will not be increased past 1.42, three minor versions prior. Increasing the minimum supported compiler version is not considered a semver breaking change as long as doing so complies with this policy.
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tokio by you, shall be licensed as MIT, without any additional terms or conditions.