feat: support to specify max files of tracing (#185)

Signed-off-by: Gaius <[email protected]>

Author: gaius-qi

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dragonfly-client"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["The Dragonfly Developers"]
 homepage = "https://d7y.io/"
 repository = "https://github.com/dragonflyoss/client.git"
@@ -28,7 +28,7 @@ home = "0.5.4"
 tracing = "0.1"
 tracing-log = "0.1"
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
-tracing-appender = "0.2"
+tracing-appender = "0.2.3"
 tracing-opentelemetry = "0.18.0"
 humantime = "2.1.0"
 serde = { version = "1.0", features = ["derive"] }

src/bin/dfdaemon/main.rs

@@ -59,7 +59,7 @@ struct Args {
         short = 'l',
         long,
         default_value = "info",
-        help = "Set the logging level [trace, debug, info, warn, error]"
+        help = "Specify the logging level [trace, debug, info, warn, error]"
     )]
     log_level: Level,
 
@@ -69,6 +69,13 @@ struct Args {
         help = "Specify the log directory"
     )]
     log_dir: PathBuf,
+
+    #[arg(
+        long,
+        default_value_t = 24,
+        help = "Specify the max number of log files"
+    )]
+    log_max_files: usize,
 }
 
 #[tokio::main]
@@ -89,6 +96,7 @@ async fn main() -> Result<(), anyhow::Error> {
         dfdaemon::NAME,
         &args.log_dir,
         args.log_level,
+        args.log_max_files,
         config.tracing.addr.to_owned(),
     );
 

src/bin/dfget/main.rs

@@ -72,21 +72,21 @@ struct Args {
         long = "timeout",
         value_parser= humantime::parse_duration,
         default_value = "2h",
-        help = "Set the timeout for downloading a file"
+        help = "Specify the timeout for downloading a file"
     )]
     timeout: Duration,
 
     #[arg(
         long = "piece-length",
         default_value_t = 4194304,
-        help = "Set the byte length of the piece"
+        help = "Specify the byte length of the piece"
     )]
     piece_length: u64,
 
     #[arg(
         long = "download-rate-limit",
         default_value_t = 2147483648,
-        help = "Set the rate limit of the downloading in bytes per second"
+        help = "Specify the rate limit of the downloading in bytes per second"
     )]
     download_rate_limit: u64,
 
@@ -102,7 +102,7 @@ struct Args {
         short = 'p',
         long = "priority",
         default_value_t = 6,
-        help = "Set the priority for scheduling task"
+        help = "Specify the priority for scheduling task"
     )]
     priority: i32,
 
@@ -124,7 +124,7 @@ struct Args {
         short = 'H',
         long = "header",
         required = false,
-        help = "Set the header for downloading file, e.g. --header='Content-Type: application/json' --header='Accept: application/json'"
+        help = "Specify the header for downloading file, e.g. --header='Content-Type: application/json' --header='Accept: application/json'"
     )]
     header: Option<Vec<String>>,
 
@@ -146,7 +146,7 @@ struct Args {
         short = 'l',
         long,
         default_value = "info",
-        help = "Set the logging level [trace, debug, info, warn, error]"
+        help = "Specify the logging level [trace, debug, info, warn, error]"
     )]
     log_level: Level,
 
@@ -157,6 +157,13 @@ struct Args {
     )]
     log_dir: PathBuf,
 
+    #[arg(
+        long,
+        default_value_t = 24,
+        help = "Specify the max number of log files"
+    )]
+    log_max_files: usize,
+
     #[arg(
         short = 'c',
         long = "dfdaemon-config",
@@ -175,7 +182,7 @@ struct Args {
     #[arg(
         long = "dfdaemon-log-level",
         default_value = "info",
-        help = "Set the dfdaemon's logging level [trace, debug, info, warn, error]"
+        help = "Specify the dfdaemon's logging level [trace, debug, info, warn, error]"
     )]
     dfdaemon_log_level: Level,
 
@@ -185,6 +192,13 @@ struct Args {
         help = "Specify the dfdaemon's log directory"
     )]
     dfdaemon_log_dir: PathBuf,
+
+    #[arg(
+        long,
+        default_value_t = 24,
+        help = "Specify the dfdaemon's max number of log files"
+    )]
+    dfdaemon_log_max_files: usize,
 }
 
 #[tokio::main]
@@ -193,14 +207,21 @@ async fn main() -> Result<(), anyhow::Error> {
     let args = Args::parse();
 
     // Initialize tracting.
-    let _guards = init_tracing(dfget::NAME, &args.log_dir, args.log_level, None);
+    let _guards = init_tracing(
+        dfget::NAME,
+        &args.log_dir,
+        args.log_level,
+        args.log_max_files,
+        None,
+    );
 
     // Get or create dfdaemon download client.
     let dfdaemon_download_client = get_or_create_dfdaemon_download_client(
         args.dfdaemon_config,
         args.endpoint.clone(),
         args.dfdaemon_log_dir,
         args.dfdaemon_log_level,
+        args.dfdaemon_log_max_files,
         args.dfdaemon_lock_path,
     )
     .await
@@ -269,6 +290,7 @@ async fn get_or_create_dfdaemon_download_client(
     endpoint: PathBuf,
     log_dir: PathBuf,
     log_level: Level,
+    log_max_files: usize,
     lock_path: PathBuf,
 ) -> Result<DfdaemonDownloadClient, anyhow::Error> {
     // Get dfdaemon download client and check its health.
@@ -288,7 +310,7 @@ async fn get_or_create_dfdaemon_download_client(
     }
 
     // Spawn a dfdaemon process.
-    let child = spawn_dfdaemon(config_path, log_dir, log_level)?;
+    let child = spawn_dfdaemon(config_path, log_dir, log_level, log_max_files)?;
     info!("spawn dfdaemon process: {:?}", child);
 
     // Initialize the timeout of checking dfdaemon's health.
@@ -333,6 +355,7 @@ fn spawn_dfdaemon(
     config_path: PathBuf,
     log_dir: PathBuf,
     log_level: Level,
+    log_max_files: usize,
 ) -> Result<Child, anyhow::Error> {
     // Create dfdaemon command.
     let mut cmd = Command::new("dfdaemon");
@@ -343,7 +366,9 @@ fn spawn_dfdaemon(
         .arg("--log-dir")
         .arg(log_dir)
         .arg("--log-level")
-        .arg(log_level.to_string());
+        .arg(log_level.to_string())
+        .arg("--log-max-files")
+        .arg(log_max_files.to_string());
 
     // Redirect stdin, stdout, stderr to /dev/null.
     cmd.stdin(Stdio::null())

src/bin/dfstore/main.rs

@@ -45,7 +45,7 @@ struct Args {
         short = 'l',
         long,
         default_value = "info",
-        help = "Set the logging level [trace, debug, info, warn, error]"
+        help = "Specify the logging level [trace, debug, info, warn, error]"
     )]
     log_level: Level,
 
@@ -56,6 +56,13 @@ struct Args {
     )]
     log_dir: PathBuf,
 
+    #[arg(
+        long,
+        default_value_t = 24,
+        help = "Specify the max number of log files"
+    )]
+    log_max_files: usize,
+
     #[command(subcommand)]
     command: Command,
 }
@@ -95,5 +102,11 @@ fn main() {
     let args = Args::parse();
 
     // Initialize tracing.
-    let _guards = init_tracing(dfstore::NAME, &args.log_dir, args.log_level, None);
+    let _guards = init_tracing(
+        dfstore::NAME,
+        &args.log_dir,
+        args.log_level,
+        args.log_max_files,
+        None,
+    );
 }

src/tracing/mod.rs

@@ -26,6 +26,7 @@ pub fn init_tracing(
     name: &str,
     log_dir: &PathBuf,
     log_level: Level,
+    log_max_files: usize,
     jaeger_addr: Option<String>,
 ) -> Vec<WorkerGuard> {
     let mut guards = vec![];
@@ -43,7 +44,13 @@ pub fn init_tracing(
     guards.push(stdout_guard);
 
     // Setup file layer.
-    let rolling_appender = RollingFileAppender::new(Rotation::DAILY, log_dir, name);
+    let rolling_appender = RollingFileAppender::builder()
+        .rotation(Rotation::HOURLY)
+        .filename_prefix(name)
+        .max_log_files(log_max_files)
+        .build(log_dir)
+        .expect("failed to create rolling file appender");
+
     let (rolling_writer, rolling_writer_guard) = tracing_appender::non_blocking(rolling_appender);
     let file_logging_layer = Layer::new()
         .with_writer(rolling_writer)