mirror of
https://github.com/tokio-rs/tracing.git
synced 2025-09-30 06:20:38 +00:00

This branch adds documentation and tests noting that the `#[instrument]` macro accepts `tracing::Level` directly. Using `tracing::Level` directly allows for IDE autocomplete and earlier detection of typos. The documentation for tracing-attributes was also rewritten to remove the usage of the second-person perspective, making it more consistent with the rest of tracing's documentation. Co-authored-by: David Barsky <me@davidbarsky.com> ; Conflicts: ; tracing-attributes/Cargo.toml ; tracing-attributes/src/lib.rs
143 lines
4.7 KiB
Rust
143 lines
4.7 KiB
Rust
use tracing::subscriber::with_default;
|
|
use tracing::Level;
|
|
use tracing_attributes::instrument;
|
|
use tracing_mock::*;
|
|
|
|
#[test]
|
|
fn named_levels() {
|
|
#[instrument(level = "trace")]
|
|
fn trace() {}
|
|
|
|
#[instrument(level = "Debug")]
|
|
fn debug() {}
|
|
|
|
#[instrument(level = "INFO")]
|
|
fn info() {}
|
|
|
|
#[instrument(level = "WARn")]
|
|
fn warn() {}
|
|
|
|
#[instrument(level = "eRrOr")]
|
|
fn error() {}
|
|
let (subscriber, handle) = subscriber::mock()
|
|
.new_span(span::mock().named("trace").at_level(Level::TRACE))
|
|
.enter(span::mock().named("trace").at_level(Level::TRACE))
|
|
.exit(span::mock().named("trace").at_level(Level::TRACE))
|
|
.new_span(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.enter(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.exit(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.new_span(span::mock().named("info").at_level(Level::INFO))
|
|
.enter(span::mock().named("info").at_level(Level::INFO))
|
|
.exit(span::mock().named("info").at_level(Level::INFO))
|
|
.new_span(span::mock().named("warn").at_level(Level::WARN))
|
|
.enter(span::mock().named("warn").at_level(Level::WARN))
|
|
.exit(span::mock().named("warn").at_level(Level::WARN))
|
|
.new_span(span::mock().named("error").at_level(Level::ERROR))
|
|
.enter(span::mock().named("error").at_level(Level::ERROR))
|
|
.exit(span::mock().named("error").at_level(Level::ERROR))
|
|
.done()
|
|
.run_with_handle();
|
|
|
|
with_default(subscriber, || {
|
|
trace();
|
|
debug();
|
|
info();
|
|
warn();
|
|
error();
|
|
});
|
|
|
|
handle.assert_finished();
|
|
}
|
|
|
|
#[test]
|
|
fn numeric_levels() {
|
|
#[instrument(level = 1)]
|
|
fn trace() {}
|
|
|
|
#[instrument(level = 2)]
|
|
fn debug() {}
|
|
|
|
#[instrument(level = 3)]
|
|
fn info() {}
|
|
|
|
#[instrument(level = 4)]
|
|
fn warn() {}
|
|
|
|
#[instrument(level = 5)]
|
|
fn error() {}
|
|
let (subscriber, handle) = subscriber::mock()
|
|
.new_span(span::mock().named("trace").at_level(Level::TRACE))
|
|
.enter(span::mock().named("trace").at_level(Level::TRACE))
|
|
.exit(span::mock().named("trace").at_level(Level::TRACE))
|
|
.new_span(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.enter(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.exit(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.new_span(span::mock().named("info").at_level(Level::INFO))
|
|
.enter(span::mock().named("info").at_level(Level::INFO))
|
|
.exit(span::mock().named("info").at_level(Level::INFO))
|
|
.new_span(span::mock().named("warn").at_level(Level::WARN))
|
|
.enter(span::mock().named("warn").at_level(Level::WARN))
|
|
.exit(span::mock().named("warn").at_level(Level::WARN))
|
|
.new_span(span::mock().named("error").at_level(Level::ERROR))
|
|
.enter(span::mock().named("error").at_level(Level::ERROR))
|
|
.exit(span::mock().named("error").at_level(Level::ERROR))
|
|
.done()
|
|
.run_with_handle();
|
|
|
|
with_default(subscriber, || {
|
|
trace();
|
|
debug();
|
|
info();
|
|
warn();
|
|
error();
|
|
});
|
|
|
|
handle.assert_finished();
|
|
}
|
|
|
|
#[test]
|
|
fn enum_levels() {
|
|
#[instrument(level = Level::TRACE)]
|
|
fn trace() {}
|
|
|
|
#[instrument(level = Level::DEBUG)]
|
|
fn debug() {}
|
|
|
|
#[instrument(level = tracing::Level::INFO)]
|
|
fn info() {}
|
|
|
|
#[instrument(level = Level::WARN)]
|
|
fn warn() {}
|
|
|
|
#[instrument(level = Level::ERROR)]
|
|
fn error() {}
|
|
let (subscriber, handle) = subscriber::mock()
|
|
.new_span(span::mock().named("trace").at_level(Level::TRACE))
|
|
.enter(span::mock().named("trace").at_level(Level::TRACE))
|
|
.exit(span::mock().named("trace").at_level(Level::TRACE))
|
|
.new_span(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.enter(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.exit(span::mock().named("debug").at_level(Level::DEBUG))
|
|
.new_span(span::mock().named("info").at_level(Level::INFO))
|
|
.enter(span::mock().named("info").at_level(Level::INFO))
|
|
.exit(span::mock().named("info").at_level(Level::INFO))
|
|
.new_span(span::mock().named("warn").at_level(Level::WARN))
|
|
.enter(span::mock().named("warn").at_level(Level::WARN))
|
|
.exit(span::mock().named("warn").at_level(Level::WARN))
|
|
.new_span(span::mock().named("error").at_level(Level::ERROR))
|
|
.enter(span::mock().named("error").at_level(Level::ERROR))
|
|
.exit(span::mock().named("error").at_level(Level::ERROR))
|
|
.done()
|
|
.run_with_handle();
|
|
|
|
with_default(subscriber, || {
|
|
trace();
|
|
debug();
|
|
info();
|
|
warn();
|
|
error();
|
|
});
|
|
|
|
handle.assert_finished();
|
|
}
|