implement filter for the reload layer/subscriber #2159
Conversation
guswynn
changed the title
|
@hawkw thanks for the review! This is RFAL! |
There was a problem hiding this comment.
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 :)
...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. |
|
RFAL! I feel like I should re-export |
guswynn
force-pushed
the
reload-filter
branch
3 times, most recently
from
74dcb78
to
60088ac
Compare
instead of re-exporting it under two different names, i would probably just rename it to something more generic (like |
|
@hawkw okay! after this merges Ill do that rename! |
|
@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! |
|
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>
# 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!
# 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
reloadlayer 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
Filteron 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