-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Allow initializing logger with additional tracing Layer #140969
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
Open
Stypox
wants to merge
1
commit into
rust-lang:master
Choose a base branch
from
Stypox:logger-layer
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+26
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,7 +42,9 @@ use tracing_core::{Event, Subscriber}; | |
use tracing_subscriber::filter::{Directive, EnvFilter, LevelFilter}; | ||
use tracing_subscriber::fmt::FmtContext; | ||
use tracing_subscriber::fmt::format::{self, FormatEvent, FormatFields}; | ||
use tracing_subscriber::layer::SubscriberExt; | ||
use tracing_subscriber::layer::{Identity, SubscriberExt}; | ||
// Re-export tracing_subscriber items so rustc_driver_impl doesn't need to depend on it. | ||
pub use tracing_subscriber::{Layer, Registry}; | ||
|
||
/// The values of all the environment variables that matter for configuring a logger. | ||
/// Errors are explicitly preserved so that we can share error handling. | ||
|
@@ -72,6 +74,15 @@ impl LoggerConfig { | |
|
||
/// Initialize the logger with the given values for the filter, coloring, and other options env variables. | ||
pub fn init_logger(cfg: LoggerConfig) -> Result<(), Error> { | ||
init_logger_with_additional_layer(cfg, Identity::new()) | ||
} | ||
|
||
/// Initialize the logger with the given values for the filter, coloring, and other options env variables. | ||
/// Additionally add a custom layer to collect logging and tracing events. | ||
pub fn init_logger_with_additional_layer( | ||
cfg: LoggerConfig, | ||
additional_tracing_layer: impl Layer<Registry> + Send + Sync, | ||
) -> Result<(), Error> { | ||
let filter = match cfg.filter { | ||
Ok(env) => EnvFilter::new(env), | ||
_ => EnvFilter::default().add_directive(Directive::from(LevelFilter::WARN)), | ||
|
@@ -104,7 +115,7 @@ pub fn init_logger(cfg: LoggerConfig) -> Result<(), Error> { | |
}; | ||
|
||
let mut layer = tracing_tree::HierarchicalLayer::default() | ||
.with_writer(io::stderr) | ||
.with_writer(io::stderr as fn() -> io::Stderr) | ||
.with_ansi(color_logs) | ||
.with_targets(true) | ||
.with_verbose_exit(verbose_entry_exit) | ||
|
@@ -124,7 +135,8 @@ pub fn init_logger(cfg: LoggerConfig) -> Result<(), Error> { | |
Err(_) => {} // no wraptree | ||
} | ||
|
||
let subscriber = tracing_subscriber::Registry::default().with(filter).with(layer); | ||
let subscriber = | ||
Registry::default().with(additional_tracing_layer).with(layer.with_filter(filter)); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This seems to change the way the filter is applied, which might explain the explosion of debug messages? |
||
match cfg.backtrace { | ||
Ok(backtrace_target) => { | ||
let fmt_layer = tracing_subscriber::fmt::layer() | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is there a fn ptr cast here now?