Skip to content

Commit 38a99d8

Browse files
QnnOkabayashihawkw
authored andcommitted
docs: add tracing-forest to "Related Crates" section (#1935)
## Motivation This PR adds [`tracing-forest`](https://crates.io/crates/tracing-forest) to the list of related crates. `tracing-forest` provides contextual coherence when writing logs, and is being used by projects like [Kanidm](https://github.com/kanidm/kanidm/). ## Solution I added it to the documentation in `lib.rs` and in the README. Am I missing anything else?
1 parent b37d8af commit 38a99d8

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,8 @@ are not maintained by the `tokio` project. These include:
399399
- [`tracing-elastic-apm`] provides a layer for reporting traces to [Elastic APM].
400400
- [`tracing-etw`] provides a layer for emitting Windows [ETW] events.
401401
- [`sentry-tracing`] provides a layer for reporting events and traces to [Sentry].
402+
- [`tracing-forest`] provides a subscriber that preserves contextual coherence by
403+
grouping together logs from the same spans during writing.
402404

403405
(if you're the maintainer of a `tracing` ecosystem crate not in this list,
404406
please let us know!)
@@ -433,6 +435,7 @@ please let us know!)
433435
[ETW]: https://docs.microsoft.com/en-us/windows/win32/etw/about-event-tracing
434436
[`sentry-tracing`]: https://crates.io/crates/sentry-tracing
435437
[Sentry]: https://sentry.io/welcome/
438+
[`tracing-forest`]: https://crates.io/crates/tracing-forest
436439

437440
**Note:** that some of the ecosystem crates are currently unreleased and
438441
undergoing active development. They may be less stable than `tracing` and

tracing/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -743,6 +743,8 @@
743743
//! - [`tracing-fluent-assertions`] provides a fluent assertions-style testing
744744
//! framework for validating the behavior of `tracing` spans.
745745
//! - [`sentry-tracing`] provides a layer for reporting events and traces to [Sentry].
746+
//! - [`tracing-forest`] provides a subscriber that preserves contextual coherence by
747+
//! grouping together logs from the same spans during writing.
746748
//!
747749
//! If you're the maintainer of a `tracing` ecosystem crate not listed above,
748750
//! please let us know! We'd love to add your project to the list!
@@ -776,6 +778,7 @@
776778
//! [`tracing-fluent-assertions`]: https://crates.io/crates/tracing-fluent-assertions
777779
//! [`sentry-tracing`]: https://crates.io/crates/sentry-tracing
778780
//! [Sentry]: https://sentry.io/welcome/
781+
//! [`tracing-forest`]: https://crates.io/crates/tracing-forest
779782
//!
780783
//! <pre class="ignore" style="white-space:normal;font:inherit;">
781784
//! <strong>Note</strong>: Some of these ecosystem crates are currently

0 commit comments

Comments
 (0)