f improve docs & remove cleanups from rotate()

Author: Anyitechs

contrib/ldk-server-config.toml

@@ -15,7 +15,7 @@ dir_path = "/tmp/ldk-server/"                 # Path for LDK and BDK data persis
 [log]
 level = "Debug"                               # Log level (Error, Warn, Info, Debug, Trace)
 #file = "/tmp/ldk-server/ldk-server.log"      # Log file path
-# Enabling `log_to_file` automatically rotate logs at `max_size_mb` or `rotation_interval_hours`. 
+# Enabling `log_to_file` automatically rotates logs at `max_size_mb` or `rotation_interval_hours`. 
 # To disable the internal rotation and keep logging to file, set `max_size_mb` # and `rotation_interval_hours` params to `0`.
 log_to_file = true                            # Enable logging to a file (default: true, also logs to both stdout and stderr)
 #max_size_mb = 50                             # Max size of log file before rotation (default: 50MB)

ldk-server/src/util/config.rs

@@ -278,8 +278,8 @@ impl ConfigBuilder {
 			self.log_max_files = Some(log_max_files);
 		}
 
-		if let Some(log_file_path) = args.log_to_file {
-			self.log_to_file = Some(log_file_path);
+		if let Some(log_to_file) = args.log_to_file {
+			self.log_to_file = Some(log_to_file);
 		}
 	}
 

ldk-server/src/util/logger.rs

@@ -13,7 +13,7 @@ use std::path::{Path, PathBuf};
 use std::sync::{Arc, Mutex};
 use std::time::SystemTime;
 
-use log::{Level, LevelFilter, Log, Metadata, Record};
+use log::{error, Level, LevelFilter, Log, Metadata, Record};
 
 struct LoggerState {
 	file: LineWriter<File>,
@@ -35,7 +35,7 @@ struct LoggerState {
 ///
 /// Example: `[2025-12-04T10:30:45Z INFO ldk_server:42] Starting up...`
 ///
-/// The logger does a native size/time-based rotation and retains the last 5 logs by default, if `max_rotated_files` is unset.
+/// The logger does a native size/time-based rotation and retains the last 5 logs by default, if `log_max_files` is unset.
 pub struct ServerLogger {
 	/// The maximum log level to display
 	level: LevelFilter,
@@ -127,9 +127,15 @@ impl ServerLogger {
 
 	/// Flushes the current file, renames it with a timestamp, opens a fresh log,
 	/// and synchronously deletes older log files.
-	fn rotate(&self, state: &mut LoggerState) -> Result<(), io::Error> {
+	fn rotate(
+		&self, state: &mut LoggerState, system_time_now: SystemTime,
+	) -> Result<(), io::Error> {
 		state.file.flush()?;
-		let log_file_path = self.log_file_path.as_ref().unwrap();
+		let log_file_path = if let Some(path) = self.log_file_path.as_ref() {
+			path
+		} else {
+			return Ok(());
+		};
 
 		let now = chrono::Utc::now().format("%Y-%m-%dT%H-%M-%SZ").to_string();
 		let mut new_path = log_file_path.to_path_buf().into_os_string();
@@ -144,12 +150,7 @@ impl ServerLogger {
 
 		// Reset our rotation triggers for the new file
 		state.bytes_written = 0;
-		state.created_at = SystemTime::now();
-
-		// Clean up old log files
-		if let Err(e) = cleanup_old_logs(log_file_path, state.log_max_files) {
-			eprintln!("Failed to clean up old log files: {}", e);
-		}
+		state.created_at = system_time_now;
 
 		Ok(())
 	}
@@ -185,6 +186,8 @@ impl Log for ServerLogger {
 				},
 			};
 
+			let mut cleanup_max_files = None;
+
 			if let Some(state_mutex) = &self.state {
 				// Log to file
 				let log_bytes = log_line.len() + 1;
@@ -205,15 +208,26 @@ impl Log for ServerLogger {
 					}
 
 					if needs_rotation {
-						if let Err(e) = self.rotate(&mut state) {
-							eprintln!("Failed to rotate log file: {}", e);
+						if let Err(e) = self.rotate(&mut state, now) {
+							error!("Failed to rotate log file: {e}");
+						} else {
+							cleanup_max_files = Some(state.log_max_files);
 						}
 					}
 
 					let _ = writeln!(state.file, "{}", log_line);
 					state.bytes_written += log_bytes;
 				}
 			}
+
+			// Clean up old log files
+			if let (Some(log_max_files), Some(log_file_path)) =
+				(cleanup_max_files, &self.log_file_path)
+			{
+				if let Err(e) = cleanup_old_logs(log_file_path, log_max_files) {
+					error!("Failed to clean up old log files: {e}");
+				}
+			}
 		}
 	}
 
@@ -276,7 +290,9 @@ fn cleanup_old_logs(log_file_path: &Path, max_files: usize) -> io::Result<()> {
 		.collect();
 
 	// Sort by modification time (oldest first)
-	entries.sort_by_key(|e| e.metadata().and_then(|m| m.modified()).unwrap_or(SystemTime::now()));
+	entries.sort_by_cached_key(|e| {
+		e.metadata().and_then(|m| m.modified()).unwrap_or(SystemTime::now())
+	});
 
 	if entries.len() > max_files {
 		for entry in entries.iter().take(entries.len() - max_files) {