subscriber: "implementing FormatEvent" docs #1727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Eliza Weisman <[email protected]>
Signed-off-by: Eliza Weisman <[email protected]>
Signed-off-by: Eliza Weisman <[email protected]>
Signed-off-by: Eliza Weisman <[email protected]>
davidbarsky
approved these changes
Nov 19, 2021
| /// does not support ANSI escape codes (such as a log file), and they should | ||
| /// not be emitted. | ||
| /// | ||
| /// Crates like [`ansi_term`] and [`owo-colors`] can be used to add ANSI |
Comment on lines
+232
to
+233
| //! The [`FormatFields`] trait determines how fields — both the event's | ||
| //! fields and fields on spans — are formatted. |
There was a problem hiding this comment.
is the use of — instead of — intentional?
There was a problem hiding this comment.
i can't remember the hotkey for typing a literal em dash on my keyboard...
Co-authored-by: David Barsky <[email protected]>
hawkw
added a commit
that referenced
this pull request
Nov 20, 2021
This branch adds some documentation to the `FormatEvent` trait in `tracing_subscriber::fmt` on how to write user-provided `FormatEvent` implementations. There's probably room for additional improvement here, but I just wanted to get something written down for now. I also fixed a broken link I noticed while I was here. Signed-off-by: Eliza Weisman <[email protected]> Co-authored-by: David Barsky <[email protected]>
hawkw
added a commit
that referenced
this pull request
Nov 20, 2021
This branch adds some documentation to the `FormatEvent` trait in `tracing_subscriber::fmt` on how to write user-provided `FormatEvent` implementations. There's probably room for additional improvement here, but I just wanted to get something written down for now. I also fixed a broken link I noticed while I was here. Signed-off-by: Eliza Weisman <[email protected]> Co-authored-by: David Barsky <[email protected]>
hawkw
added a commit
that referenced
this pull request
Nov 20, 2021
This branch adds some documentation to the `FormatEvent` trait in `tracing_subscriber::fmt` on how to write user-provided `FormatEvent` implementations. There's probably room for additional improvement here, but I just wanted to get something written down for now. I also fixed a broken link I noticed while I was here. Signed-off-by: Eliza Weisman <[email protected]> Co-authored-by: David Barsky <[email protected]>
hawkw
added a commit
that referenced
this pull request
Nov 20, 2021
This branch adds some documentation to the `FormatEvent` trait in `tracing_subscriber::fmt` on how to write user-provided `FormatEvent` implementations. There's probably room for additional improvement here, but I just wanted to get something written down for now. I also fixed a broken link I noticed while I was here. Signed-off-by: Eliza Weisman <[email protected]> Co-authored-by: David Barsky <[email protected]>
hawkw
added a commit
that referenced
this pull request
Nov 20, 2021
# 0.3.2 (Nov 19, 2021) ### Fixed - **fmt**: Fixed `MakeWriter` filtering not working with `BoxMakeWriter` ([#1694]) ### Added - **fmt**: `Writer::has_ansi_escapes` method to check if an output supports ANSI terminal formatting escape codes ([#1696]) - **fmt**: Added additional ANSI terminal formatting to field formatters when supported ([#1702]) - **fmt**: Added `FmtContext::span_scope`, `FmtContext::event_scope`, and `FmtContext::parent_span` methods for accessing the current span and its scope when formatting an event ([#1728]) - **fmt**: Improved documentation on implementing event formatters ([#1727]) [#1694]: #1694 [#1696]: #1696 [#1702]: #1702 [#1728]: #1728 [#1727]: #1727
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
# 0.3.2 (Nov 19, 2021) ### Fixed - **fmt**: Fixed `MakeWriter` filtering not working with `BoxMakeWriter` ([tokio-rs#1694]) ### Added - **fmt**: `Writer::has_ansi_escapes` method to check if an output supports ANSI terminal formatting escape codes ([tokio-rs#1696]) - **fmt**: Added additional ANSI terminal formatting to field formatters when supported ([tokio-rs#1702]) - **fmt**: Added `FmtContext::span_scope`, `FmtContext::event_scope`, and `FmtContext::parent_span` methods for accessing the current span and its scope when formatting an event ([tokio-rs#1728]) - **fmt**: Improved documentation on implementing event formatters ([tokio-rs#1727]) [tokio-rs#1694]: tokio-rs#1694 [tokio-rs#1696]: tokio-rs#1696 [tokio-rs#1702]: tokio-rs#1702 [tokio-rs#1728]: tokio-rs#1728 [tokio-rs#1727]: tokio-rs#1727
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This branch adds some documentation to the
FormatEventtrait intracing_subscriber::fmton how to write user-providedFormatEventimplementations. There's probably room for additional improvement here,
but I just wanted to get something written down for now.
I also fixed a broken link I noticed while I was here.