Charlie Marsh
aeefe65227
## Summary I'm unable to run `puffin-cli` on `main` as the `tracing-durations-export` is marked as optional, but the crate actually depends on it to compile. Further, without `tracing-durations-export`, there are `Option` types that can't resolve to a concrete type. This PR fixes compilation with and without the feature.
101 lines
3.8 KiB
Rust
101 lines
3.8 KiB
Rust
use tracing::level_filters::LevelFilter;
|
|
#[cfg(feature = "tracing-durations-export")]
|
|
use tracing_durations_export::{
|
|
plot::PlotConfig, DurationsLayer, DurationsLayerBuilder, DurationsLayerDropGuard,
|
|
};
|
|
use tracing_subscriber::layer::SubscriberExt;
|
|
use tracing_subscriber::util::SubscriberInitExt;
|
|
use tracing_subscriber::{EnvFilter, Layer, Registry};
|
|
use tracing_tree::time::Uptime;
|
|
use tracing_tree::HierarchicalLayer;
|
|
|
|
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
|
|
pub(crate) enum Level {
|
|
/// Suppress all tracing output by default (overrideable by `RUST_LOG`).
|
|
#[default]
|
|
Default,
|
|
/// Show debug messages by default (overrideable by `RUST_LOG`).
|
|
Verbose,
|
|
}
|
|
|
|
/// Configure `tracing` based on the given [`Level`], taking into account the `RUST_LOG` environment
|
|
/// variable.
|
|
///
|
|
/// The [`Level`] is used to dictate the default filters (which can be overridden by the `RUST_LOG`
|
|
/// environment variable) along with the formatting of the output. For example, [`Level::Verbose`]
|
|
/// includes targets and timestamps, along with all `puffin=debug` messages by default.
|
|
pub(crate) fn setup_logging(level: Level, duration: impl Layer<Registry> + Send + Sync) {
|
|
match level {
|
|
Level::Default => {
|
|
// Show nothing, but allow `RUST_LOG` to override.
|
|
let filter = EnvFilter::builder()
|
|
.with_default_directive(LevelFilter::OFF.into())
|
|
.from_env_lossy();
|
|
|
|
// Regardless of the tracing level, show messages without any adornment.
|
|
tracing_subscriber::registry()
|
|
.with(duration)
|
|
.with(filter)
|
|
.with(
|
|
tracing_subscriber::fmt::layer()
|
|
.without_time()
|
|
.with_target(false)
|
|
.with_writer(std::io::sink),
|
|
)
|
|
.init();
|
|
}
|
|
Level::Verbose => {
|
|
// Show `DEBUG` messages from the CLI crate, but allow `RUST_LOG` to override.
|
|
let filter = EnvFilter::try_from_default_env()
|
|
.or_else(|_| EnvFilter::try_new("puffin=debug"))
|
|
.unwrap();
|
|
|
|
// Regardless of the tracing level, include the uptime and target for each message.
|
|
tracing_subscriber::registry()
|
|
.with(duration)
|
|
.with(filter)
|
|
.with(
|
|
HierarchicalLayer::default()
|
|
.with_targets(true)
|
|
.with_timer(Uptime::default())
|
|
.with_writer(std::io::stderr),
|
|
)
|
|
.init();
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Setup the `TRACING_DURATIONS_FILE` environment variable to enable tracing durations.
|
|
#[cfg(feature = "tracing-durations-export")]
|
|
pub(crate) fn setup_duration() -> (
|
|
Option<DurationsLayer<Registry>>,
|
|
Option<DurationsLayerDropGuard>,
|
|
) {
|
|
if let Ok(location) = std::env::var("TRACING_DURATIONS_FILE") {
|
|
let location = std::path::PathBuf::from(location);
|
|
if let Some(parent) = location.parent() {
|
|
fs_err::create_dir_all(parent)
|
|
.expect("Failed to create parent of TRACING_DURATIONS_FILE");
|
|
}
|
|
let plot_config = PlotConfig {
|
|
multi_lane: true,
|
|
min_length: Some(std::time::Duration::from_secs_f32(0.002)),
|
|
remove: Some(
|
|
["get_cached_with_callback".to_string()]
|
|
.into_iter()
|
|
.collect(),
|
|
),
|
|
..PlotConfig::default()
|
|
};
|
|
let (layer, guard) = DurationsLayerBuilder::default()
|
|
.durations_file(&location)
|
|
.plot_file(location.with_extension("svg"))
|
|
.plot_config(plot_config)
|
|
.build()
|
|
.expect("Couldn't create TRACING_DURATIONS_FILE files");
|
|
(Some(layer), Some(guard))
|
|
} else {
|
|
(None, None)
|
|
}
|
|
}
|