Merge branch 'Tunglies-main'

Author: emabee

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.31.3] - 2025-09-22
+
+Add variant `Cleanup::KeepForDays(usize)` to have log files being deleted after a given number of days.
+Kudos goes to [Tunglies](https://github.com/Tunglies).
+
 ## [0.31.2] - 2025-06-27
 
 Add syslog-call based `SyslogWriter` connection

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "flexi_logger"
-version = "0.31.2"
+version = "0.31.3"
 authors = ["emabee <[email protected]>"]
 categories = ["development-tools::debugging"]
 description = """
@@ -69,6 +69,7 @@ nix = { version = "0.30.1", optional = true, features = ["hostname", "syslog"] }
 [dev-dependencies]
 cond_sync = "0.2"
 either = "1.9"
+filetime = "0.2.26"
 flate2 = "1.0"
 glob = "0.3"
 serde_derive = "1.0"

README.md

@@ -183,7 +183,7 @@ Adds the ability to filter logs by text, but also adds a dependency on the regex
 
 ### **`trc`**
 
-An experimental feature that allows using `flexi_logger` functionality with `tracing`.
+Allows using `flexi_logger` functionality with `tracing`.
 
 ## Versions
 

src/parameters/cleanup.rs

@@ -17,11 +17,15 @@ pub enum Cleanup {
     Never,
 
     /// The specified number of rotated log files are kept.
-    /// Older files are deleted, if necessary.
+    /// Older files are deleted.
     KeepLogFiles(usize),
 
+    /// Log files are kept for the specified number of days.
+    /// Older files are deleted.
+    KeepForDays(usize),
+
     /// The specified number of rotated log files are compressed and kept.
-    /// Older files are deleted, if necessary.
+    /// Older files are deleted.
     #[cfg_attr(docsrs, doc(cfg(feature = "compress")))]
     #[cfg(feature = "compress")]
     KeepCompressedFiles(usize),

src/writers/file_log_writer/state/list_and_cleanup.rs

@@ -90,18 +90,19 @@ pub(crate) fn remove_or_compress_too_old_logfiles_impl(
     infix_filter: &InfixFilter,
     writes_direct: bool,
 ) -> Result<(), std::io::Error> {
-    let (mut log_limit, compress_limit) = match *cleanup_config {
+    let (mut log_limit, day_limit, compress_limit): (usize, usize, usize) = match *cleanup_config {
         Cleanup::Never => {
             return Ok(());
         }
-        Cleanup::KeepLogFiles(log_limit) => (log_limit, 0),
+        Cleanup::KeepLogFiles(log_limit) => (log_limit, 0, 0),
 
-        #[cfg(feature = "compress")]
-        Cleanup::KeepCompressedFiles(compress_limit) => (0, compress_limit),
+        Cleanup::KeepForDays(day_limit) => (0, day_limit, 0),
 
+        #[cfg(feature = "compress")]
+        Cleanup::KeepCompressedFiles(compress_limit) => (0, 0, compress_limit),
         #[cfg(feature = "compress")]
         Cleanup::KeepLogAndCompressedFiles(log_limit, compress_limit) => {
-            (log_limit, compress_limit)
+            (log_limit, 0, compress_limit)
         }
     };
 
@@ -146,6 +147,20 @@ pub(crate) fn remove_or_compress_too_old_logfiles_impl(
                     }
                 }
             }
+        } else if day_limit > 0 {
+            // Remove files older than the configured day limit
+            let mod_limit = std::time::SystemTime::now()
+                .checked_sub(std::time::Duration::from_secs(
+                    u64::try_from(day_limit)
+                        .ok()
+                        .and_then(|days| days.checked_mul(24 * 3600))
+                        .unwrap_or(u64::MAX),
+                ))
+                .unwrap_or(std::time::UNIX_EPOCH);
+
+            if std::fs::metadata(&file)?.modified()? < mod_limit {
+                std::fs::remove_file(&file)?;
+            }
         }
     }
 

tests/test_cleanup_by_day_limit.rs

@@ -0,0 +1,67 @@
+mod test_utils;
+
+#[test]
+fn test_cleanup_by_day_limit() {
+    use filetime::{set_file_mtime, FileTime};
+    use flexi_logger::{Cleanup, Criterion, Duplicate, FileSpec, Logger, Naming};
+    use log::*;
+    use std::{fs, thread, time::Duration};
+
+    let directory = test_utils::dir();
+
+    Logger::try_with_str("info")
+        .unwrap()
+        .log_to_file(FileSpec::default().directory(&directory))
+        .duplicate_to_stderr(Duplicate::Info)
+        .rotate(
+            Criterion::Size(100),
+            Naming::Numbers,
+            Cleanup::KeepForDays(1),
+        )
+        .start()
+        .unwrap();
+
+    for i in 0..5 {
+        info!("log line {i}");
+    }
+
+    let mut log_files: Vec<_> = fs::read_dir(&directory)
+        .unwrap()
+        .filter_map(|e| {
+            let p = e.unwrap().path();
+            if p.extension().map(|ext| ext == "log").unwrap_or(false) {
+                Some(p)
+            } else {
+                None
+            }
+        })
+        .collect();
+    let two_days_ago = std::time::SystemTime::now() - Duration::from_secs(2 * 24 * 3600);
+    let ft = FileTime::from_system_time(two_days_ago);
+    for file in &log_files {
+        if file.exists() {
+            let _ = set_file_mtime(file, ft);
+        }
+    }
+    log_files.sort();
+    let old_file = log_files.first().expect("should have log files");
+    let two_days_ago = std::time::SystemTime::now() - Duration::from_secs(2 * 24 * 3600);
+    let ft = FileTime::from_system_time(two_days_ago);
+    if old_file.exists() {
+        set_file_mtime(old_file, ft).unwrap();
+    }
+
+    for i in 0..3 {
+        info!("trigger cleanup {i}");
+        thread::sleep(Duration::from_millis(120));
+    }
+
+    let start = std::time::Instant::now();
+    while old_file.exists() && start.elapsed().as_secs() < 2 {
+        thread::sleep(Duration::from_millis(50));
+    }
+    assert!(
+        !old_file.exists(),
+        "old file should be deleted by day_limit cleanup"
+    );
+}