dev_scope/shared/
logging.rs

1use clap::{ArgGroup, Parser};
2use std::fs::File;
3use std::path::PathBuf;
4
5use tracing::level_filters::LevelFilter;
6use tracing_subscriber::{filter::filter_fn, prelude::*};
7use tracing_subscriber::{
8    fmt::format::{Format, PrettyFields},
9    layer::SubscriberExt,
10    Registry,
11};
12
13#[derive(Parser, Debug)]
14#[clap(group = ArgGroup::new("logging"))]
15pub struct LoggingOpts {
16    /// A level of verbosity, and can be used multiple times
17    #[arg(short, long, action = clap::ArgAction::Count, global(true), group = "logging")]
18    pub debug: u8,
19
20    /// Enable warn logging
21    #[arg(short, long, global(true), group = "logging")]
22    pub warn: bool,
23
24    /// Disable everything but error logging
25    #[arg(short, long, global(true), group = "logging")]
26    pub error: bool,
27
28    #[arg(skip = LevelFilter::INFO)]
29    default_level: LevelFilter,
30}
31
32impl LoggingOpts {
33    pub fn with_new_default(&self, new_default: LevelFilter) -> Self {
34        Self {
35            debug: self.debug,
36            warn: self.warn,
37            error: self.error,
38            default_level: new_default,
39        }
40    }
41
42    pub fn to_level_filter(&self) -> LevelFilter {
43        if self.error {
44            LevelFilter::ERROR
45        } else if self.warn {
46            LevelFilter::WARN
47        } else if self.debug == 0 {
48            self.default_level
49        } else if self.debug == 1 {
50            LevelFilter::DEBUG
51        } else {
52            LevelFilter::TRACE
53        }
54    }
55
56    pub fn configure_logging(
57        &self,
58        run_id: &str,
59        prefix: &str,
60    ) -> (tracing_appender::non_blocking::WorkerGuard, String) {
61        let file_name = format!("scope-{}-{}.log", prefix, run_id);
62        let full_file_name = format!("/tmp/scope/{}", file_name);
63        std::fs::create_dir_all("/tmp/scope").expect("to be able to create tmp dir");
64
65        let file_path = PathBuf::from(&full_file_name);
66        let (non_blocking, guard) = tracing_appender::non_blocking(
67            File::create(file_path).expect("to be able to create log file"),
68        );
69
70        let file_output = tracing_subscriber::fmt::layer()
71            .event_format(Format::default().pretty())
72            .with_writer(non_blocking);
73
74        let console_output = tracing_subscriber::fmt::layer()
75            .event_format(
76                Format::default()
77                    .with_target(false)
78                    .without_time()
79                    .compact(),
80            )
81            .fmt_fields(PrettyFields::new());
82
83        let level_filter = self.to_level_filter();
84        let subscriber = Registry::default()
85            .with(console_output.with_filter(filter_fn(move |metadata| {
86                metadata.target() == "user" && level_filter >= *metadata.level()
87                    || metadata.target() == "always"
88            })))
89            .with(file_output);
90
91        tracing::subscriber::set_global_default(subscriber)
92            .expect("setting default subscriber failed");
93
94        (guard, full_file_name)
95    }
96}
dev_scope/shared/logging.rs

dev_scope/shared/
logging.rs
