forked/h2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

start adding tracing spans to internals (#478)

Browse Source 
We've adopted `tracing` for diagnostics, but currently, it is just being
used as a drop-in replacement for the `log` crate. Ideally, we would
want to start emitting more structured diagnostics, using `tracing`'s
`Span`s and structured key-value fields.

A lot of the logging in `h2` is already written in a style that imitates
the formatting of structured key-value logs, but as textual log
messages. Migrating the logs to structured `tracing` events therefore is
pretty easy to do. I've also started adding spans, mostly in the read
path.

Finally, I've updated the tests to use `tracing` rather than
`env_logger`. The tracing setup happens in a macro, so that a span for
each test with the test's name can be generated and entered. This will
make the test output easier to read if multiple tests are run
concurrently with `--nocapture`.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
This commit is contained in:
Eliza Weisman
2020-08-17 17:29:22 -07:00
committed by GitHub
parent d3c2bba18b
commit fc7f63f641
25 changed files with 363 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
tests/h2-tests/tests/server.rs
View File

@@ -10,7 +10,7 @@ const SETTINGS_ACK: &'static [u8] = &[0, 0, 0, 4, 1, 0, 0, 0, 0];
#[tokio::test]
async fn read_preface_in_multiple_frames() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let mock = mock_io::Builder::new()
.read(b"PRI * HTTP/2.0")
@@ -28,7 +28,7 @@ async fn read_preface_in_multiple_frames() {
#[tokio::test]
async fn server_builder_set_max_concurrent_streams() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let mut settings = frame::Settings::default();
@@ -72,7 +72,7 @@ async fn server_builder_set_max_concurrent_streams() {
#[tokio::test]
async fn serve_request() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -107,7 +107,7 @@ async fn serve_request() {
#[tokio::test]
async fn serve_connect() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -138,7 +138,7 @@ async fn serve_connect() {
#[tokio::test]
async fn push_request() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -222,7 +222,7 @@ async fn push_request() {
#[tokio::test]
async fn push_request_against_concurrency() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -306,7 +306,7 @@ async fn push_request_against_concurrency() {
#[tokio::test]
async fn push_request_with_data() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -372,7 +372,7 @@ async fn push_request_with_data() {
#[tokio::test]
async fn push_request_between_data() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -443,7 +443,7 @@ fn accept_with_pending_connections_after_socket_close() {}
#[tokio::test]
async fn recv_invalid_authority() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let bad_auth = util::byte_str("not:a/good authority");
@@ -470,7 +470,7 @@ async fn recv_invalid_authority() {
#[tokio::test]
async fn recv_connection_header() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let req = |id, name, val| {
@@ -507,7 +507,7 @@ async fn recv_connection_header() {
#[tokio::test]
async fn sends_reset_cancel_when_req_body_is_dropped() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -539,7 +539,7 @@ async fn sends_reset_cancel_when_req_body_is_dropped() {
#[tokio::test]
async fn abrupt_shutdown() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -583,7 +583,7 @@ async fn abrupt_shutdown() {
#[tokio::test]
async fn graceful_shutdown() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -658,7 +658,7 @@ async fn graceful_shutdown() {
#[tokio::test]
async fn goaway_even_if_client_sent_goaway() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -707,7 +707,7 @@ async fn goaway_even_if_client_sent_goaway() {
#[tokio::test]
async fn sends_reset_cancel_when_res_body_is_dropped() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -761,7 +761,7 @@ async fn sends_reset_cancel_when_res_body_is_dropped() {
#[tokio::test]
async fn too_big_headers_sends_431() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -797,7 +797,7 @@ async fn too_big_headers_sends_431() {
#[tokio::test]
async fn too_big_headers_sends_reset_after_431_if_not_eos() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -832,7 +832,7 @@ async fn too_big_headers_sends_reset_after_431_if_not_eos() {
#[tokio::test]
async fn poll_reset() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -872,7 +872,7 @@ async fn poll_reset() {
#[tokio::test]
async fn poll_reset_io_error() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -913,7 +913,7 @@ async fn poll_reset_io_error() {
#[tokio::test]
async fn poll_reset_after_send_response_is_user_error() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {
@@ -967,7 +967,7 @@ async fn poll_reset_after_send_response_is_user_error() {
#[tokio::test]
async fn server_error_on_unclean_shutdown() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let srv = server::Builder::new().handshake::<_, Bytes>(io);
@@ -980,7 +980,7 @@ async fn server_error_on_unclean_shutdown() {
#[tokio::test]
async fn request_without_authority() {
let _ = env_logger::try_init();
h2_support::trace_init!();
let (io, mut client) = mock::new();
let client = async move {