Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tracing-subscriber and use tracing-tree when testing #586

Merged
merged 1 commit into from
Jan 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion tests/h2-support/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ edition = "2018"
[dependencies]
h2 = { path = "../..", features = ["stream", "unstable"] }

atty = "0.2"
bytes = "1"
tracing = "0.1"
tracing-subscriber = { version = "0.2", default-features = false, features = ["fmt", "chrono", "ansi"] }
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt"] }
tracing-tree = "0.2"
futures = { version = "0.3", default-features = false }
http = "0.2"
tokio = { version = "1", features = ["time"] }
Expand Down
46 changes: 11 additions & 35 deletions tests/h2-support/src/trace.rs
Original file line number Diff line number Diff line change
@@ -1,41 +1,17 @@
use std::{io, str};
pub use tracing;
pub use tracing_subscriber;

pub fn init() -> tracing::dispatcher::DefaultGuard {
tracing::subscriber::set_default(
tracing_subscriber::fmt()
.with_max_level(tracing::Level::TRACE)
.with_span_events(tracing_subscriber::fmt::format::FmtSpan::CLOSE)
.with_writer(PrintlnWriter { _p: () })
.finish(),
)
}

struct PrintlnWriter {
_p: (),
}
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::util::SubscriberInitExt;

impl tracing_subscriber::fmt::MakeWriter for PrintlnWriter {
type Writer = PrintlnWriter;
fn make_writer(&self) -> Self::Writer {
PrintlnWriter { _p: () }
}
}

impl io::Write for PrintlnWriter {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let s = str::from_utf8(buf).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
println!("{}", s);
Ok(s.len())
}

fn write_fmt(&mut self, fmt: std::fmt::Arguments<'_>) -> io::Result<()> {
println!("{}", fmt);
Ok(())
}
pub fn init() -> tracing::dispatcher::DefaultGuard {
let use_colors = atty::is(atty::Stream::Stdout);
let layer = tracing_tree::HierarchicalLayer::default()
.with_writer(tracing_subscriber::fmt::writer::TestWriter::default())
.with_indent_lines(true)
.with_ansi(use_colors)
.with_targets(true)
.with_indent_amount(2);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

take it or leave it: perhaps we want to add

Suggested change
.with_indent_amount(2);
.with_indent_amount(2)
.with_thread_ids(true)
.with_thread_names(true);

in particular, adding thread names will give us a nice way to know which test the events were logged from, since the thread's name defaults to the name of the test.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added it but I'm not sure this is useful: I only ever look at logs running a single test, not many of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capture d’écran 2022-01-20 à 10 45 20

It's a bit verbose as you can see.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, we could remove it --- i suppose that since libtest is capturing the logs now, they'll also be printed out per-test. the only reason to consider having thread names here is if we have tests that spawn multiple threads and they give names to those threads...and we only have one test that spawns threads (https://github.com/hyperium/h2/search?q=thread%3A%3Aspawn).

i'm fine with removing the thread-name configuration, then!


fn flush(&mut self) -> io::Result<()> {
Ok(())
}
tracing_subscriber::registry().with(layer).set_default()
}