implement filter for the reload layer/subscriber #2159

guswynn · 2022-06-09T23:05:49Z

Motivation

The reload layer doesn't (and can't) implement downcasting correctly, which breaks certain subscribers like the opentelemetry one.

Solution

. Most usages of this type (including mine) are just to change the filter, so this pr implements Filter on the reload type to allow users to not need to wrap the whole layer trait. Another advantage of this is that the common-case critical sections are shortened

hawkw

looks good to me overall, thanks for adding a test! i had some minor suggestions.

tracing-subscriber/src/reload.rs

guswynn · 2022-06-13T15:21:42Z

@hawkw thanks for the review! This is RFAL!

davidbarsky

made a few requested changes as part of our adherence to our style guide. broadly speaking, we don't use the second-person tense in reference documentation, but do use it in longer-term guides (e.g., https://tokio.rs/tokio/tutorial). I apologize for being a stickler for this stuff and I wish we can automate this better :)

tracing-subscriber/src/reload.rs

hawkw · 2022-06-13T17:44:49Z

made a few requested changes as part of our adherence to our style guide.

...we should probably actually write down a style guide for docs, huh? maybe in CONTRIBUTING.md?

davidbarsky · 2022-06-13T18:31:35Z

...we should probably actually write down a style guide for docs, huh? maybe in CONTRIBUTING.md?

Probably. An example of some documentation on a method, a struct, and some do's and do not's would probably go a long way.

guswynn · 2022-06-13T21:48:37Z

RFAL! I feel like I should re-export reload::Subscriber as reload::Filter as well, or name it something else and re-export as Subscriber

hawkw · 2022-06-13T21:55:02Z

RFAL! I feel like I should re-export reload::Subscriber as reload::Filter as well, or name it something else and re-export as Subscriber

instead of re-exporting it under two different names, i would probably just rename it to something more generic (like reload::Reload) and deprecate the existing name. Let's do that in a follow-up, though, because we can just do a hard rename on v0.2.x, and we'll need to do a deprecation on v0.1.x.

guswynn · 2022-06-13T21:56:33Z

@hawkw okay! after this merges Ill do that rename!

hawkw · 2022-06-14T16:23:49Z

@davidbarsky do you want to review the docs again, or shall i merge this?

davidbarsky · 2022-06-14T16:25:41Z

@davidbarsky do you want to review the docs again, or shall i merge this?

I realized I missed a bit on the module documentation; lemme fix that. I think it should be good to go after, though!

davidbarsky

missed a few things, sorry!

tracing-subscriber/src/reload.rs

guswynn · 2022-06-15T16:48:59Z

Is this merge-able?

hawkw · 2022-06-15T18:22:26Z

Is this merge-able?

Yup, I'll get it merged and then backport to v0.1.x!

## Motivation The `reload` layer doesn't (and can't) implement downcasting correctly, which breaks certain layers like the opentelemetry one. ## Solution Most uses of the `reload` module (including mine) are just to change the filter. Therefore, this PR implements `Filter` for `reload::Layer` to allow users to not need to wrap the whole layer trait. Another advantage of this is that the common-case critical sections are shortened.

…kio-rs#2159) The `reload` subscriber doesn't (and can't) implement downcasting correctly, which breaks certain subscribers like the opentelemetry one. Most uses of the `reload` module (including mine) are just to change the filter. Therefore, this PR implements `Filter` for `reload::Subscriber` to allow users to not need to wrap the whole layer trait. Another advantage of this is that the common-case critical sections are shortened.

## Motivation The `reload` layer doesn't (and can't) implement downcasting correctly, which breaks certain `Layer`s which require downcasting (such as `tracing-opentelemetry`'s `OpenTelemetryLayer`). ## Solution Most usages of `reload` (including mine) are just to change a `Filter`, so this PR implements `Filter` on the `reload::Layer` type to allow users to not need to wrap the whole `Filtered` layer. Another advantage of this is that the common-case critical sections are shortened Co-authored-by: Eliza Weisman <eliza@buoyant.io>

@ben0x539

# 0.3.12 (Jun 29, 2022) This release of `tracing-subscriber` adds a new `Layer::event_enabled` method, which allows `Layer`s to filter events *after* their field values are recorded; a `Filter` implementation for `reload::Layer`, to make using `reload` with per-layer filtering more ergonomic, and additional inherent method downcasting APIs for the `Layered` type. In addition, it includes dependency updates, and minor fixes for documentation and feature flagging. ### Added - **layer**: `Layer::event_enabled` method, which can be implemented to filter events based on their field values (#2008) - **reload**: `Filter` implementation for `reload::Layer` (#2159) - **layer**: `Layered::downcast_ref` and `Layered::is` inherent methods (#2160) ### Changed - **parking_lot**: Updated dependency on `parking_lot` to 0.13.0 (#2143) - Replaced `lazy_static` dependency with `once_cell` (#2147) ### Fixed - Don't enable `tracing-core` features by default (#2107) - Several documentation link and typo fixes (#2064, #2068, #2077, #2161, #1088) Thanks to @ben0x539, @jamesmunns, @georgemp, @james7132, @jswrenn, @CAD97, and @guswynn for contributing to this release!

@ben0x539

# 0.3.12 (Jun 29, 2022) This release of `tracing-subscriber` adds a new `Layer::event_enabled` method, which allows `Layer`s to filter events *after* their field values are recorded; a `Filter` implementation for `reload::Layer`, to make using `reload` with per-layer filtering more ergonomic, and additional inherent method downcasting APIs for the `Layered` type. In addition, it includes dependency updates, and minor fixes for documentation and feature flagging. ### Added - **layer**: `Layer::event_enabled` method, which can be implemented to filter events based on their field values (#2008) - **reload**: `Filter` implementation for `reload::Layer` (#2159) - **layer**: `Layered::downcast_ref` and `Layered::is` inherent methods (#2160) ### Changed - **parking_lot**: Updated dependency on `parking_lot` to 0.13.0 (#2143) - Replaced `lazy_static` dependency with `once_cell` (#2147) ### Fixed - Don't enable `tracing-core` features by default (#2107) - Several documentation link and typo fixes (#2064, #2068, #2077, #2161, #1088) Thanks to @ben0x539, @jamesmunns, @georgemp, @james7132, @jswrenn, @CAD97, and @guswynn for contributing to this release!

## Motivation The `reload` layer doesn't (and can't) implement downcasting correctly, which breaks certain `Layer`s which require downcasting (such as `tracing-opentelemetry`'s `OpenTelemetryLayer`). ## Solution Most usages of `reload` (including mine) are just to change a `Filter`, so this PR implements `Filter` on the `reload::Layer` type to allow users to not need to wrap the whole `Filtered` layer. Another advantage of this is that the common-case critical sections are shortened Co-authored-by: Eliza Weisman <eliza@buoyant.io>

@ben0x539

# 0.3.12 (Jun 29, 2022) This release of `tracing-subscriber` adds a new `Layer::event_enabled` method, which allows `Layer`s to filter events *after* their field values are recorded; a `Filter` implementation for `reload::Layer`, to make using `reload` with per-layer filtering more ergonomic, and additional inherent method downcasting APIs for the `Layered` type. In addition, it includes dependency updates, and minor fixes for documentation and feature flagging. ### Added - **layer**: `Layer::event_enabled` method, which can be implemented to filter events based on their field values (tokio-rs#2008) - **reload**: `Filter` implementation for `reload::Layer` (tokio-rs#2159) - **layer**: `Layered::downcast_ref` and `Layered::is` inherent methods (tokio-rs#2160) ### Changed - **parking_lot**: Updated dependency on `parking_lot` to 0.13.0 (tokio-rs#2143) - Replaced `lazy_static` dependency with `once_cell` (tokio-rs#2147) ### Fixed - Don't enable `tracing-core` features by default (tokio-rs#2107) - Several documentation link and typo fixes (tokio-rs#2064, tokio-rs#2068, tokio-rs#2077, tokio-rs#2161, tokio-rs#1088) Thanks to @ben0x539, @jamesmunns, @georgemp, @james7132, @jswrenn, @CAD97, and @guswynn for contributing to this release!

guswynn requested review from hawkw, davidbarsky and a team as code owners June 9, 2022 23:05

guswynn changed the title ~~implement for the layer/subscriber~~ implement filter for the reload layer/subscriber Jun 9, 2022

hawkw approved these changes Jun 12, 2022

View reviewed changes

tracing-subscriber/src/reload.rs Outdated Show resolved Hide resolved

tracing-subscriber/src/reload.rs Outdated Show resolved Hide resolved

tracing-subscriber/src/reload.rs Show resolved Hide resolved

tracing-subscriber/src/reload.rs Outdated Show resolved Hide resolved

guswynn force-pushed the reload-filter branch from 87fd6d2 to 71743c4 Compare June 13, 2022 15:21

davidbarsky requested changes Jun 13, 2022

View reviewed changes

guswynn force-pushed the reload-filter branch 3 times, most recently from 74dcb78 to 60088ac Compare June 13, 2022 21:51

guswynn force-pushed the reload-filter branch from 60088ac to 419c0d2 Compare June 13, 2022 21:57

hawkw requested a review from davidbarsky June 13, 2022 22:21

davidbarsky reviewed Jun 14, 2022

View reviewed changes

tracing-subscriber/src/reload.rs Show resolved Hide resolved

tracing-subscriber/src/reload.rs Outdated Show resolved Hide resolved

implement reload for the layer/subscriber

4c9b7d3

guswynn force-pushed the reload-filter branch from 419c0d2 to 4c9b7d3 Compare June 14, 2022 16:39

davidbarsky approved these changes Jun 14, 2022

View reviewed changes

Merge branch 'master' into reload-filter

1328041

hawkw enabled auto-merge (squash) June 15, 2022 18:22

hawkw merged commit 3046981 into tokio-rs:master Jun 15, 2022

guswynn deleted the reload-filter branch June 16, 2022 15:26

hawkw mentioned this pull request Jun 22, 2022

backport 9 commits from master #2174

Merged

hawkw mentioned this pull request Jun 29, 2022

subscriber: prepare to release v0.3.12 #2187

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

implement filter for the reload layer/subscriber #2159

implement filter for the reload layer/subscriber #2159

guswynn commented Jun 9, 2022

hawkw left a comment

guswynn commented Jun 13, 2022

davidbarsky left a comment •

edited

Loading

hawkw commented Jun 13, 2022

davidbarsky commented Jun 13, 2022

guswynn commented Jun 13, 2022 •

edited

Loading

hawkw commented Jun 13, 2022

guswynn commented Jun 13, 2022

hawkw commented Jun 14, 2022

davidbarsky commented Jun 14, 2022

davidbarsky left a comment

guswynn commented Jun 15, 2022

hawkw commented Jun 15, 2022

implement filter for the reload layer/subscriber #2159

implement filter for the reload layer/subscriber #2159

Conversation

guswynn commented Jun 9, 2022

Motivation

Solution

hawkw left a comment

Choose a reason for hiding this comment

guswynn commented Jun 13, 2022

davidbarsky left a comment • edited Loading

Choose a reason for hiding this comment

hawkw commented Jun 13, 2022

davidbarsky commented Jun 13, 2022

guswynn commented Jun 13, 2022 • edited Loading

hawkw commented Jun 13, 2022

guswynn commented Jun 13, 2022

hawkw commented Jun 14, 2022

davidbarsky commented Jun 14, 2022

davidbarsky left a comment

Choose a reason for hiding this comment

guswynn commented Jun 15, 2022

hawkw commented Jun 15, 2022

davidbarsky left a comment •

edited

Loading

guswynn commented Jun 13, 2022 •

edited

Loading