Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example for reloading a global filtering layer #1971

Merged
merged 10 commits into from
Mar 17, 2022
27 changes: 25 additions & 2 deletions tracing-subscriber/src/reload.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,29 @@
//!
//! # Examples
//!
//! Reloading a [`Filtered`](crate::filter::Filtered) layer to change the filter at runtime.
//!
//! Reloading a global filtering layer:
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! ```rust
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! # use tracing::info;
//! # use tracing_subscriber::{filter,fmt,reload,Registry,prelude::*};
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! # fn main() {
//! let filter = filter::LevelFilter::WARN;
//! let (filter, reload_handle) = reload::Layer::new(filter);
//! Registry::default()
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! .with(filter)
//! .with(fmt::Layer::default())
//! .init();
//! #
//! # // specifying the Registry type is required
//! # let _: &reload::Handle<filter::LevelFilter ,Registry> = &reload_handle;
//! #
//! info!("This will be ignored");
//! reload_handle.modify(|filter| *filter = filter::LevelFilter::INFO);
//! info!("This will be logged");
//! # }
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! ```
//!
//! Reloading a [`Filtered`](crate::filter::Filtered) layer:
//! ```rust
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! # use tracing::info;
//! # use tracing_subscriber::{filter,fmt,reload,Registry,prelude::*};
//! # fn main() {
Expand All @@ -25,6 +45,9 @@
//! # filter::LevelFilter, Registry>,Registry>
//! # = &reload_handle;
//! #
//! Registry::default()
TimoFreiberg marked this conversation as resolved.
Show resolved Hide resolved
//! .with(filtered_layer)
//! .init();
//! info!("This will be ignored");
//! reload_handle.modify(|layer| *layer.filter_mut() = filter::LevelFilter::INFO);
//! info!("This will be logged");
Expand Down