subscriber: add `MakeWriter` combinators #1274

hawkw · 2021-03-01T19:51:13Z

Depends on #1141.

This branch adds a MakeWriterExt trait which adds a number of
combinators for composing multiple types implementing MakeWriter.
MakeWriters can now be teed together, filtered with minimum and
maximum levels, filtered with a Metadata predicate, and combined with
a fallback for when a writer is not made for a particular Metadata.

I've also added a MakeWriter impl for std::fs::File, because &File
implements Write. Ideally, we'd have a default impl of MakeWriter
for T where &T: Write, but that's not possible due to the impl of
MakeWriter for F: Fn() -> T: Write. We could add a generic by_ref
adapter for any T where &T: Write, though...

davidbarsky

This looks super cool, modulo warnings and docs! Mind re-upping me for review once that's done?

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

…o eliza/output-levels

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

davidbarsky · 2021-06-24T22:49:48Z

tracing-subscriber/src/fmt/writer.rs

+
+    /// Wraps `self` with a predicate that takes a span or event's [`Metadata`]
+    /// and returns a `bool`. The returned [`MakeWriter`]'s
+    /// [`MakeWriter::make_writer_for`][mwf] method will check the predicate to


I don't see mwf defined as a doc link here. Is that intentional?

whoops, my bad --- i forgot to add that.

davidbarsky · 2021-06-24T22:52:42Z

tracing-subscriber/src/fmt/writer.rs

+/// This is not intended to be implemented directly for user-defined
+/// [`MakeWriter`]s; instead, it should be imported when the desired methods are
+/// used.


Maybe add this trait to the subscriber prelude?

tracing-subscriber/src/fmt/writer.rs

Co-authored-by: David Barsky <me@davidbarsky.com>

This adds a section to the `Level` docs explaining the comparison rules for `Level` and `LevelFilter`. It turns out this wasn't really explicitly documented anywhere. See #1274 (comment) Signed-off-by: Eliza Weisman <eliza@buoyant.io>

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

This backports #1274 from `master`. Depends on #1141. This branch adds a `MakeWriterExt` trait which adds a number of combinators for composing multiple types implementing `MakeWriter`. `MakeWriter`s can now be teed together, filtered with minimum and maximum levels, filtered with a `Metadata` predicate, and combined with a fallback for when a writer is _not_ made for a particular `Metadata`. I've also added a `MakeWriter` impl for `Arc<W>` when `&W` implements `Write`. This enables `File`s to be used as `MakeWriter`s similarly to how we will be able to in 0.3, with the additional overhead of having to do ref-counting because we can't return a reference from `MakeWriter` until the next breaking change. Signed-off-by: Eliza Weisman <eliza@buoyant.io>

This adds a section to the `Level` docs explaining the comparison rules for `Level` and `LevelFilter`. It turns out this wasn't really explicitly documented anywhere. I may have gone a bit overboard on this, but I think the new docs should be helpful... See #1274 (comment) Signed-off-by: Eliza Weisman <eliza@buoyant.io> Co-authored-by: David Barsky <me@davidbarsky.com>

This backports #1274 from `master`. Depends on #1141. This branch adds a `MakeWriterExt` trait which adds a number of combinators for composing multiple types implementing `MakeWriter`. `MakeWriter`s can now be teed together, filtered with minimum and maximum levels, filtered with a `Metadata` predicate, and combined with a fallback for when a writer is _not_ made for a particular `Metadata`. I've also added a `MakeWriter` impl for `Arc<W>` when `&W` implements `Write`. This enables `File`s to be used as `MakeWriter`s similarly to how we will be able to in 0.3, with the additional overhead of having to do ref-counting because we can't return a reference from `MakeWriter` until the next breaking change. Signed-off-by: Eliza Weisman <eliza@buoyant.io>

This adds a section to the `Level` docs explaining the comparison rules for `Level` and `LevelFilter`. It turns out this wasn't really explicitly documented anywhere. I may have gone a bit overboard on this, but I think the new docs should be helpful... See #1274 (comment) Signed-off-by: Eliza Weisman <eliza@buoyant.io> Co-authored-by: David Barsky <me@davidbarsky.com>

@Folyd

# 0.2.19 (June 25, 2021) ### Deprecated - **registry**: `SpanRef::parents`, `SpanRef::from_root`, and `Context::scope` iterators, which are replaced by new `SpanRef::scope` and `Scope::from_root` iterators (#1413) ### Added - **registry**: `SpanRef::scope` method, which returns a leaf-to-root `Iterator` including the leaf span (#1413) - **registry**: `Scope::from_root` method, which reverses the `scope` iterator to iterate root-to-leaf (#1413) - **registry**: `Context::event_span` method, which looks up the parent span of an event (#1434) - **registry**: `Context::event_scope` method, returning a `Scope` iterator over the span scope of an event (#1434) - **fmt**: `MakeWriter::make_writer_for` method, which allows returning a different writer based on a span or event's metadata (#1141) - **fmt**: `MakeWriterExt` trait, with `with_max_level`, `with_min_level`, `with_filter`, `and`, and `or_else` combinators (#1274) - **fmt**: `MakeWriter` implementation for `Arc<W> where &W: io::Write` (#1274) Thanks to @teozkr and @Folyd for contributing to this release!

@Folyd

# 0.2.19 (June 25, 2021) ### Deprecated - **registry**: `SpanRef::parents`, `SpanRef::from_root`, and `Context::scope` iterators, which are replaced by new `SpanRef::scope` and `Scope::from_root` iterators (#1413) ### Added - **registry**: `SpanRef::scope` method, which returns a leaf-to-root `Iterator` including the leaf span (#1413) - **registry**: `Scope::from_root` method, which reverses the `scope` iterator to iterate root-to-leaf (#1413) - **registry**: `Context::event_span` method, which looks up the parent span of an event (#1434) - **registry**: `Context::event_scope` method, returning a `Scope` iterator over the span scope of an event (#1434) - **fmt**: `MakeWriter::make_writer_for` method, which allows returning a different writer based on a span or event's metadata (#1141) - **fmt**: `MakeWriterExt` trait, with `with_max_level`, `with_min_level`, `with_filter`, `and`, and `or_else` combinators (#1274) - **fmt**: `MakeWriter` implementation for `Arc<W> where &W: io::Write` (#1274) Thanks to @teozkr and @Folyd for contributing to this release!

This backports tokio-rs#1274 from `master`. Depends on tokio-rs#1141. This branch adds a `MakeWriterExt` trait which adds a number of combinators for composing multiple types implementing `MakeWriter`. `MakeWriter`s can now be teed together, filtered with minimum and maximum levels, filtered with a `Metadata` predicate, and combined with a fallback for when a writer is _not_ made for a particular `Metadata`. I've also added a `MakeWriter` impl for `Arc<W>` when `&W` implements `Write`. This enables `File`s to be used as `MakeWriter`s similarly to how we will be able to in 0.3, with the additional overhead of having to do ref-counting because we can't return a reference from `MakeWriter` until the next breaking change. Signed-off-by: Eliza Weisman <eliza@buoyant.io>

@Folyd

# 0.2.19 (June 25, 2021) ### Deprecated - **registry**: `SpanRef::parents`, `SpanRef::from_root`, and `Context::scope` iterators, which are replaced by new `SpanRef::scope` and `Scope::from_root` iterators (tokio-rs#1413) ### Added - **registry**: `SpanRef::scope` method, which returns a leaf-to-root `Iterator` including the leaf span (tokio-rs#1413) - **registry**: `Scope::from_root` method, which reverses the `scope` iterator to iterate root-to-leaf (tokio-rs#1413) - **registry**: `Context::event_span` method, which looks up the parent span of an event (tokio-rs#1434) - **registry**: `Context::event_scope` method, returning a `Scope` iterator over the span scope of an event (tokio-rs#1434) - **fmt**: `MakeWriter::make_writer_for` method, which allows returning a different writer based on a span or event's metadata (tokio-rs#1141) - **fmt**: `MakeWriterExt` trait, with `with_max_level`, `with_min_level`, `with_filter`, `and`, and `or_else` combinators (tokio-rs#1274) - **fmt**: `MakeWriter` implementation for `Arc<W> where &W: io::Write` (tokio-rs#1274) Thanks to @teozkr and @Folyd for contributing to this release!

hawkw requested review from davidbarsky and a team as code owners March 1, 2021 19:51

hawkw changed the base branch from master to eliza/make-for-metadata March 1, 2021 19:51

davidbarsky requested changes Mar 1, 2021

View reviewed changes

Base automatically changed from eliza/make-for-metadata to master May 14, 2021 22:55

hawkw added 2 commits June 23, 2021 11:06

subscriber: add MakeWriter combinators

dfc6229

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

wip docs

20dee71

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

hawkw force-pushed the eliza/output-levels branch from 195d9c0 to 20dee71 Compare June 23, 2021 23:53

hawkw added 3 commits June 24, 2021 11:04

test fixup

ed0ab24

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

fixup examples

29182f5

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

Merge branch 'master' into eliza/output-levels

b16031e

hawkw changed the title ~~[WIP]: subscriber: add MakeWriter combinators~~ subscriber: add MakeWriter combinators Jun 24, 2021

hawkw requested a review from davidbarsky June 24, 2021 18:07

hawkw self-assigned this Jun 24, 2021

hawkw and others added 4 commits June 24, 2021 11:11

add bound that rustc 1.42.0 apparently needs

cb49875

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

Merge branch 'eliza/output-levels' of github.com:tokio-rs/tracing int…

3f5efa1

…o eliza/output-levels

Merge branch 'master' into eliza/output-levels

596dffd

apparently 1.42.0 can't infer this either

129cd25

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

davidbarsky reviewed Jun 24, 2021

View reviewed changes

Update tracing-subscriber/src/fmt/writer.rs

c919f7a

Co-authored-by: David Barsky <me@davidbarsky.com>

hawkw mentioned this pull request Jun 25, 2021

core: add a brief docs section on comparing levels #1446

Merged

review feedback

e2bec0a

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

hawkw requested a review from davidbarsky June 25, 2021 20:15

davidbarsky approved these changes Jun 25, 2021

View reviewed changes

hawkw merged commit d6298cd into master Jun 25, 2021

hawkw deleted the eliza/output-levels branch June 25, 2021 20:30

hawkw mentioned this pull request Jun 25, 2021

backport recent changes from master #1447

Merged

hawkw mentioned this pull request Jun 26, 2021

subscriber: prepare to release 0.2.19 #1448

Merged

davidbarsky mentioned this pull request Sep 26, 2023

chore: backport roughly a year's worth of changes #2728

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

subscriber: add `MakeWriter` combinators #1274

subscriber: add `MakeWriter` combinators #1274

hawkw commented Mar 1, 2021 •

edited

Loading

davidbarsky left a comment

davidbarsky Jun 24, 2021

hawkw Jun 25, 2021

davidbarsky Jun 24, 2021

subscriber: add MakeWriter combinators #1274

subscriber: add MakeWriter combinators #1274

Conversation

hawkw commented Mar 1, 2021 • edited Loading

davidbarsky left a comment

Choose a reason for hiding this comment

davidbarsky Jun 24, 2021

Choose a reason for hiding this comment

hawkw Jun 25, 2021

Choose a reason for hiding this comment

davidbarsky Jun 24, 2021

Choose a reason for hiding this comment

subscriber: add `MakeWriter` combinators #1274

subscriber: add `MakeWriter` combinators #1274

hawkw commented Mar 1, 2021 •

edited

Loading