reth_node_core/args/
log.rs

1//! clap [Args](clap::Args) for logging configuration.
2
3use crate::dirs::{LogsDir, PlatformPath};
4use clap::{ArgAction, Args, ValueEnum};
5use reth_tracing::{
6    tracing_subscriber::filter::Directive, FileInfo, FileWorkerGuard, LayerInfo, Layers, LogFormat,
7    RethTracer, Tracer,
8};
9use std::{fmt, fmt::Display};
10use tracing::{level_filters::LevelFilter, Level};
11/// Constant to convert megabytes to bytes
12const MB_TO_BYTES: u64 = 1024 * 1024;
13
14/// The log configuration.
15#[derive(Debug, Args)]
16#[command(next_help_heading = "Logging")]
17pub struct LogArgs {
18    /// The format to use for logs written to stdout.
19    #[arg(long = "log.stdout.format", value_name = "FORMAT", global = true, default_value_t = LogFormat::Terminal)]
20    pub log_stdout_format: LogFormat,
21
22    /// The filter to use for logs written to stdout.
23    #[arg(long = "log.stdout.filter", value_name = "FILTER", global = true, default_value = "")]
24    pub log_stdout_filter: String,
25
26    /// The format to use for logs written to the log file.
27    #[arg(long = "log.file.format", value_name = "FORMAT", global = true, default_value_t = LogFormat::Terminal)]
28    pub log_file_format: LogFormat,
29
30    /// The filter to use for logs written to the log file.
31    #[arg(long = "log.file.filter", value_name = "FILTER", global = true, default_value = "debug")]
32    pub log_file_filter: String,
33
34    /// The path to put log files in.
35    #[arg(long = "log.file.directory", value_name = "PATH", global = true, default_value_t)]
36    pub log_file_directory: PlatformPath<LogsDir>,
37
38    /// The prefix name of the log files.
39    #[arg(long = "log.file.name", value_name = "NAME", global = true, default_value = "reth.log")]
40    pub log_file_name: String,
41
42    /// The maximum size (in MB) of one log file.
43    #[arg(long = "log.file.max-size", value_name = "SIZE", global = true, default_value_t = 200)]
44    pub log_file_max_size: u64,
45
46    /// The maximum amount of log files that will be stored. If set to 0, background file logging
47    /// is disabled.
48    #[arg(long = "log.file.max-files", value_name = "COUNT", global = true, default_value_t = 5)]
49    pub log_file_max_files: usize,
50
51    /// Write logs to journald.
52    #[arg(long = "log.journald", global = true)]
53    pub journald: bool,
54
55    /// The filter to use for logs written to journald.
56    #[arg(
57        long = "log.journald.filter",
58        value_name = "FILTER",
59        global = true,
60        default_value = "error"
61    )]
62    pub journald_filter: String,
63
64    /// Sets whether or not the formatter emits ANSI terminal escape codes for colors and other
65    /// text formatting.
66    #[arg(
67        long,
68        value_name = "COLOR",
69        global = true,
70        default_value_t = ColorMode::Always
71    )]
72    pub color: ColorMode,
73
74    /// The verbosity settings for the tracer.
75    #[command(flatten)]
76    pub verbosity: Verbosity,
77}
78
79impl LogArgs {
80    /// Creates a [`LayerInfo`] instance.
81    fn layer_info(&self, format: LogFormat, filter: String, use_color: bool) -> LayerInfo {
82        LayerInfo::new(
83            format,
84            self.verbosity.directive().to_string(),
85            filter,
86            use_color.then(|| self.color.to_string()),
87        )
88    }
89
90    /// File info from the current log options.
91    fn file_info(&self) -> FileInfo {
92        FileInfo::new(
93            self.log_file_directory.clone().into(),
94            self.log_file_name.clone(),
95            self.log_file_max_size * MB_TO_BYTES,
96            self.log_file_max_files,
97        )
98    }
99
100    /// Initializes tracing with the configured options from cli args.
101    ///
102    /// Uses default layers for tracing. If you need to include custom layers,
103    /// use `init_tracing_with_layers` instead.
104    ///
105    /// Returns the file worker guard if a file worker was configured.
106    pub fn init_tracing(&self) -> eyre::Result<Option<FileWorkerGuard>> {
107        self.init_tracing_with_layers(Layers::new())
108    }
109
110    /// Initializes tracing with the configured options from cli args.
111    ///
112    /// Returns the file worker guard, and the file name, if a file worker was configured.
113    pub fn init_tracing_with_layers(
114        &self,
115        layers: Layers,
116    ) -> eyre::Result<Option<FileWorkerGuard>> {
117        let mut tracer = RethTracer::new();
118
119        let stdout = self.layer_info(self.log_stdout_format, self.log_stdout_filter.clone(), true);
120        tracer = tracer.with_stdout(stdout);
121
122        if self.journald {
123            tracer = tracer.with_journald(self.journald_filter.clone());
124        }
125
126        if self.log_file_max_files > 0 {
127            let info = self.file_info();
128            let file = self.layer_info(self.log_file_format, self.log_file_filter.clone(), false);
129            tracer = tracer.with_file(file, info);
130        }
131
132        let guard = tracer.init_with_layers(layers)?;
133        Ok(guard)
134    }
135}
136
137/// The color mode for the cli.
138#[derive(Debug, Copy, Clone, ValueEnum, Eq, PartialEq)]
139pub enum ColorMode {
140    /// Colors on
141    Always,
142    /// Auto-detect
143    Auto,
144    /// Colors off
145    Never,
146}
147
148impl Display for ColorMode {
149    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
150        match self {
151            Self::Always => write!(f, "always"),
152            Self::Auto => write!(f, "auto"),
153            Self::Never => write!(f, "never"),
154        }
155    }
156}
157
158/// The verbosity settings for the cli.
159#[derive(Debug, Copy, Clone, Args)]
160#[command(next_help_heading = "Display")]
161pub struct Verbosity {
162    /// Set the minimum log level.
163    ///
164    /// -v      Errors
165    /// -vv     Warnings
166    /// -vvv    Info
167    /// -vvvv   Debug
168    /// -vvvvv  Traces (warning: very verbose!)
169    #[arg(short, long, action = ArgAction::Count, global = true, default_value_t = 3, verbatim_doc_comment, help_heading = "Display")]
170    verbosity: u8,
171
172    /// Silence all log output.
173    #[arg(long, alias = "silent", short = 'q', global = true, help_heading = "Display")]
174    quiet: bool,
175}
176
177impl Verbosity {
178    /// Get the corresponding [Directive] for the given verbosity, or none if the verbosity
179    /// corresponds to silent.
180    pub fn directive(&self) -> Directive {
181        if self.quiet {
182            LevelFilter::OFF.into()
183        } else {
184            let level = match self.verbosity - 1 {
185                0 => Level::ERROR,
186                1 => Level::WARN,
187                2 => Level::INFO,
188                3 => Level::DEBUG,
189                _ => Level::TRACE,
190            };
191
192            level.into()
193        }
194    }
195}
reth_node_core/args/log.rs

reth_node_core/args/
log.rs
