From a448d2898b270880b0441023abf715204c64fb6e Mon Sep 17 00:00:00 2001 From: Martin Molzer Date: Sun, 21 Aug 2022 17:07:23 +0200 Subject: [PATCH 1/4] add tracing-web to the list of related crates --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 4aa5dba15f..afd2592fac 100644 --- a/README.md +++ b/README.md @@ -392,6 +392,8 @@ are not maintained by the `tokio` project. These include: _inside_ of functions. - [`tracing-wasm`] provides a `Collector`/`Subscriber` implementation that reports events and spans via browser `console.log` and [User Timing API (`window.performance`)]. +- [`tracing-web`] provides a layer implementation of level-aware logging of events to web browsers' `console.*` and span events to + the [User Timing API (`window.performance`)]. - [`test-log`] takes care of initializing `tracing` for tests, based on environment variables with an `env_logger` compatible syntax. - [`tracing-unwrap`] provides convenience methods to report failed unwraps on `Result` or `Option` types to a `Collector`. @@ -427,6 +429,7 @@ please let us know!) [`color-eyre`]: https://docs.rs/color-eyre [`spandoc`]: https://docs.rs/spandoc [`tracing-wasm`]: https://docs.rs/tracing-wasm +[`tracing-web`]: https://docs.rs/tracing-web [`test-log`]: https://crates.io/crates/test-log [User Timing API (`window.performance`)]: https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API [`tracing-unwrap`]: https://docs.rs/tracing-unwrap From 5aeb27005daa02a297fed805959a0f083e640a3f Mon Sep 17 00:00:00 2001 From: Martin Molzer Date: Sun, 21 Aug 2022 17:09:11 +0200 Subject: [PATCH 2/4] change link to crates.io --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index afd2592fac..ea99f8af83 100644 --- a/README.md +++ b/README.md @@ -429,7 +429,7 @@ please let us know!) [`color-eyre`]: https://docs.rs/color-eyre [`spandoc`]: https://docs.rs/spandoc [`tracing-wasm`]: https://docs.rs/tracing-wasm -[`tracing-web`]: https://docs.rs/tracing-web +[`tracing-web`]: https://crates.io/crates/tracing-web [`test-log`]: https://crates.io/crates/test-log [User Timing API (`window.performance`)]: https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API [`tracing-unwrap`]: https://docs.rs/tracing-unwrap From f60eb69014e4077682ad2c55521d03572593c9e6 Mon Sep 17 00:00:00 2001 From: Martin Molzer Date: Thu, 25 Aug 2022 15:42:56 +0200 Subject: [PATCH 3/4] address review: line wrap and add in lib docs --- README.md | 4 ++-- tracing/src/lib.rs | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ea99f8af83..3fa9226777 100644 --- a/README.md +++ b/README.md @@ -392,8 +392,8 @@ are not maintained by the `tokio` project. These include: _inside_ of functions. - [`tracing-wasm`] provides a `Collector`/`Subscriber` implementation that reports events and spans via browser `console.log` and [User Timing API (`window.performance`)]. -- [`tracing-web`] provides a layer implementation of level-aware logging of events to web browsers' `console.*` and span events to - the [User Timing API (`window.performance`)]. +- [`tracing-web`] provides a layer implementation of level-aware logging of events + to web browsers' `console.*` and span events to the [User Timing API (`window.performance`)]. - [`test-log`] takes care of initializing `tracing` for tests, based on environment variables with an `env_logger` compatible syntax. - [`tracing-unwrap`] provides convenience methods to report failed unwraps on `Result` or `Option` types to a `Collector`. diff --git a/tracing/src/lib.rs b/tracing/src/lib.rs index 64b7763d45..94a5a25131 100644 --- a/tracing/src/lib.rs +++ b/tracing/src/lib.rs @@ -788,6 +788,8 @@ //! in [bunyan] format, enriched with timing information. //! - [`tracing-wasm`] provides a `Collect`/`Subscribe` implementation that reports //! events and spans via browser `console.log` and [User Timing API (`window.performance`)]. +//! - [`tracing-web`] provides a layer implementation of level-aware logging of events +//! to web browsers' `console.*` and span events to the [User Timing API (`window.performance`)]. //! - [`tide-tracing`] provides a [tide] middleware to trace all incoming requests and responses. //! - [`test-log`] takes care of initializing `tracing` for tests, based on //! environment variables with an `env_logger` compatible syntax. From a592e1c60d6c440aaa2c5e978f4b3ce13772ee70 Mon Sep 17 00:00:00 2001 From: Martin Molzer Date: Thu, 25 Aug 2022 15:44:09 +0200 Subject: [PATCH 4/4] add missing link in docs comment --- tracing/src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/tracing/src/lib.rs b/tracing/src/lib.rs index 94a5a25131..2e8ab20244 100644 --- a/tracing/src/lib.rs +++ b/tracing/src/lib.rs @@ -824,6 +824,7 @@ //! [`tracing-bunyan-formatter`]: https://crates.io/crates/tracing-bunyan-formatter //! [bunyan]: https://github.com/trentm/node-bunyan //! [`tracing-wasm`]: https://docs.rs/tracing-wasm +//! [`tracing-web`]: https://docs.rs/tracing-web //! [User Timing API (`window.performance`)]: https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API //! [`tide-tracing`]: https://crates.io/crates/tide-tracing //! [tide]: https://crates.io/crates/tide