itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 07:20:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add tracing-forest to "Related Crates" section (#1935)

Browse Source 
## 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?
This commit is contained in:
Quinn 2022-02-17 14:14:53 -05:00 committed by Eliza Weisman
parent b37d8afd29
commit 38a99d8362
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -399,6 +399,8 @@ are not maintained by the `tokio` project. These include:
- [`tracing-elastic-apm`] provides a layer for reporting traces to [Elastic APM].
- [`tracing-etw`] provides a layer for emitting Windows [ETW] events.
- [`sentry-tracing`] provides a layer for reporting events and traces to [Sentry].
- [`tracing-forest`] provides a subscriber that preserves contextual coherence by
grouping together logs from the same spans during writing.
(if you're the maintainer of a `tracing` ecosystem crate not in this list,
please let us know!)
@ -433,6 +435,7 @@ please let us know!)
[ETW]: https://docs.microsoft.com/en-us/windows/win32/etw/about-event-tracing
[`sentry-tracing`]: https://crates.io/crates/sentry-tracing
[Sentry]: https://sentry.io/welcome/
[`tracing-forest`]: https://crates.io/crates/tracing-forest
**Note:** that some of the ecosystem crates are currently unreleased and
undergoing active development. They may be less stable than `tracing` and

3
tracing/src/lib.rs
View File

@ -743,6 +743,8 @@
//! - [`tracing-fluent-assertions`] provides a fluent assertions-style testing
//! framework for validating the behavior of `tracing` spans.
//! - [`sentry-tracing`] provides a layer for reporting events and traces to [Sentry].
//! - [`tracing-forest`] provides a subscriber that preserves contextual coherence by
//! grouping together logs from the same spans during writing.
//!
//! If you're the maintainer of a `tracing` ecosystem crate not listed above,
//! please let us know! We'd love to add your project to the list!
@ -776,6 +778,7 @@
//! [`tracing-fluent-assertions`]: https://crates.io/crates/tracing-fluent-assertions
//! [`sentry-tracing`]: https://crates.io/crates/sentry-tracing
//! [Sentry]: https://sentry.io/welcome/
//! [`tracing-forest`]: https://crates.io/crates/tracing-forest
//!
//! <pre class="ignore" style="white-space:normal;font:inherit;">
//! <strong>Note</strong>: Some of these ecosystem crates are currently