feat(stackable-telemetry): Allow customization of the rolling file appender max log files

Author: NickLarsenNZ

crates/stackable-telemetry/CHANGELOG.md

@@ -7,8 +7,9 @@ All notable changes to this project will be documented in this file.
 ### Added
 
 - Allow customization of the rolling file appender [#995].
-  - rotation period
-  - filename suffix
+  - Add required `filename_suffix` field.
+  - Add `with_rotation_period` method.
+  - Add `with_max_log_files` method.
 
 [#995]: https://github.com/stackabletech/operator-rs/pull/995
 

crates/stackable-telemetry/src/tracing/mod.rs

@@ -277,6 +277,7 @@ impl Tracing {
             file_log_dir,
             rotation_period,
             filename_suffix,
+            max_log_files,
         } = &self.file_log_settings
         {
             let env_filter_layer = env_filter_builder(
@@ -287,8 +288,15 @@ impl Tracing {
             let file_appender = RollingFileAppender::builder()
                 .rotation(rotation_period.clone())
                 .filename_prefix(self.service_name.to_string())
-                .filename_suffix(filename_suffix)
-                .max_log_files(6)
+                .filename_suffix(filename_suffix);
+
+            let file_appender = if let Some(max_log_files) = max_log_files {
+                file_appender.max_log_files(*max_log_files)
+            } else {
+                file_appender
+            };
+
+            let file_appender = file_appender
                 .build(file_log_dir)
                 .context(InitRollingFileAppenderSnafu)?;
 
@@ -732,6 +740,7 @@ mod test {
                 file_log_dir: PathBuf::from("/abc_file_dir"),
                 rotation_period: Rotation::NEVER,
                 filename_suffix: "tracing-rs.json".to_owned(),
+                max_log_files: None,
             }
         );
         assert_eq!(

crates/stackable-telemetry/src/tracing/settings/file_log.rs

@@ -27,6 +27,9 @@ pub enum FileLogSettings {
 
         /// Suffix for log filenames.
         filename_suffix: String,
+
+        /// Keep the last `n` files on disk.
+        max_log_files: Option<usize>,
     },
 }
 
@@ -49,6 +52,7 @@ pub struct FileLogSettingsBuilder {
     pub(crate) file_log_dir: PathBuf,
     pub(crate) rotation_period: Rotation,
     pub(crate) filename_suffix: String,
+    pub(crate) max_log_files: Option<usize>,
 }
 
 impl FileLogSettingsBuilder {
@@ -58,13 +62,20 @@ impl FileLogSettingsBuilder {
         self
     }
 
+    /// Set maximum number of log files to keep.
+    pub fn with_max_log_files(mut self, max_log_files: usize) -> Self {
+        self.max_log_files = Some(max_log_files);
+        self
+    }
+
     /// Consumes self and returns a valid [`FileLogSettings`] instance.
     pub fn build(self) -> FileLogSettings {
         FileLogSettings::Enabled {
             common_settings: self.common_settings,
             file_log_dir: self.file_log_dir,
             rotation_period: self.rotation_period,
             filename_suffix: self.filename_suffix,
+            max_log_files: self.max_log_files,
         }
     }
 }
@@ -97,12 +108,14 @@ mod test {
             file_log_dir: PathBuf::from("/logs"),
             rotation_period: Rotation::HOURLY,
             filename_suffix: "tracing-rs.log".to_owned(),
+            max_log_files: Some(6),
         };
         let result = Settings::builder()
             .with_environment_variable("hello")
             .with_default_level(LevelFilter::DEBUG)
             .file_log_settings_builder(PathBuf::from("/logs"), "tracing-rs.json")
             .with_rotation_period(Rotation::HOURLY)
+            .with_max_log_files(6)
             .build();
 
         assert_eq!(expected, result);

crates/stackable-telemetry/src/tracing/settings/mod.rs

@@ -98,6 +98,7 @@ impl SettingsBuilder {
             file_log_dir: path.as_ref().to_path_buf(),
             rotation_period: Rotation::NEVER,
             filename_suffix: filename_suffix.into(),
+            max_log_files: None,
         }
     }