Implement a new rotation policy Period (#74)

Author: lioriz

README.md

@@ -17,7 +17,7 @@ Fast, highly configurable Rust logging crate, inspired by the C++ logging librar
    - manually implementing for more flexibility.
  - Various combinable sinks:
     - standard streams with optional color support;
-    - files (single file, rotating hourly, daily or by file size);
+    - files (single file, rotating hourly, daily, periodically or by file size);
     - platform-specific (e.g. `journald` for Linux and `OutputDebugStringW` for Windows);
     - ... and able to implement one yourself.
  - Configuring via environment variables or TOML[^1].

spdlog/benches/spdlog-rs/spdlog_rs.rs

@@ -100,6 +100,7 @@ fn bench_rotating_inner(bencher: &mut Bencher, rotation_policy: RotationPolicy)
                 RotationPolicy::FileSize(_) => "rotating_file_size",
                 RotationPolicy::Daily { .. } => "rotating_daily",
                 RotationPolicy::Hourly => "rotating_hourly",
+                RotationPolicy::Period { .. } => "rotating_period",
             }))
             .rotation_policy(rotation_policy)
             .max_files(common::ROTATING_FILES)

spdlog/examples/02_file.rs

@@ -1,4 +1,4 @@
-use std::{env, sync::Arc};
+use std::{env, sync::Arc, time::Duration};
 
 use spdlog::{
     prelude::*,
@@ -7,7 +7,10 @@ use spdlog::{
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     configure_file_logger()?;
-    configure_rotating_file_logger()?;
+    configure_rotating_daily_file_logger()?;
+    configure_rotating_size_file_logger()?;
+    configure_rotating_hourly_file_logger()?;
+    configure_rotating_period_file_logger()?;
 
     Ok(())
 }
@@ -24,8 +27,8 @@ fn configure_file_logger() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
-fn configure_rotating_file_logger() -> Result<(), Box<dyn std::error::Error>> {
-    let path = env::current_exe()?.with_file_name("rotating.log");
+fn configure_rotating_daily_file_logger() -> Result<(), Box<dyn std::error::Error>> {
+    let path = env::current_exe()?.with_file_name("rotating_daily.log");
 
     let file_sink = Arc::new(
         RotatingFileSink::builder()
@@ -36,7 +39,60 @@ fn configure_rotating_file_logger() -> Result<(), Box<dyn std::error::Error>> {
     let new_logger = Arc::new(Logger::builder().sink(file_sink).build()?);
     spdlog::set_default_logger(new_logger);
 
-    info!("this log will be written to the file `rotating.log`, and the file will be rotated daily at 00:00");
+    info!("this log will be written to the file `rotating_daily.log`, and the file will be rotated daily at 00:00");
+
+    Ok(())
+}
+
+fn configure_rotating_size_file_logger() -> Result<(), Box<dyn std::error::Error>> {
+    let path = env::current_exe()?.with_file_name("rotating_size.log");
+
+    let file_sink = Arc::new(
+        RotatingFileSink::builder()
+            .base_path(path)
+            .rotation_policy(RotationPolicy::FileSize(1024))
+            .build()?,
+    );
+    let new_logger = Arc::new(Logger::builder().sink(file_sink).build()?);
+    spdlog::set_default_logger(new_logger);
+
+    info!("this log will be written to the file `rotating_size.log`, and the file will be rotated when its size reaches 1024 bytes");
+
+    Ok(())
+}
+
+fn configure_rotating_hourly_file_logger() -> Result<(), Box<dyn std::error::Error>> {
+    let path = env::current_exe()?.with_file_name("rotating_hourly.log");
+
+    let file_sink = Arc::new(
+        RotatingFileSink::builder()
+            .base_path(path)
+            .rotation_policy(RotationPolicy::Hourly)
+            .build()?,
+    );
+    let new_logger = Arc::new(Logger::builder().sink(file_sink).build()?);
+    spdlog::set_default_logger(new_logger);
+
+    info!("this log will be written to the file `rotating_hourly.log`, and the file will be rotated every hour");
+
+    Ok(())
+}
+
+fn configure_rotating_period_file_logger() -> Result<(), Box<dyn std::error::Error>> {
+    let path = env::current_exe()?.with_file_name("rotating_period.log");
+
+    let file_sink = Arc::new(
+        RotatingFileSink::builder()
+            .base_path(path)
+            .rotation_policy(RotationPolicy::Period(Duration::from_secs(
+                60 * 90, // 90 minutes
+            )))
+            .build()?,
+    );
+    let new_logger = Arc::new(Logger::builder().sink(file_sink).build()?);
+    spdlog::set_default_logger(new_logger);
+
+    info!("this log will be written to the file `rotating_period.log`, and the file will be rotated every 1.5 hours");
 
     Ok(())
 }