rotating_file_writer.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "file_writer.h"
#include "../interfaces/writer_category.h"
 
#include <kcenon/logger/logger_export.h>
 
#include <chrono>
#include <vector>
#include <sstream>
 
namespace kcenon::logger {
 
enum class rotation_type {
    size,           
    daily,          
    hourly,         
    size_and_time   
};
 
class LOGGER_SYSTEM_API rotating_file_writer : public file_writer {
public:
    rotating_file_writer(const std::string& filename,
                        size_t max_size,
                        size_t max_files,
                        size_t check_interval = 100);
 
    rotating_file_writer(const std::string& filename,
                        rotation_type type,
                        size_t max_files,
                        size_t check_interval = 100);
 
    rotating_file_writer(const std::string& filename,
                        rotation_type type,
                        size_t max_size,
                        size_t max_files,
                        size_t check_interval = 100);
 
    std::string get_name() const override { return "rotating_file"; }
 
    void rotate();
 
public:
    common::VoidResult write(const log_entry& entry) override;
 
private:
    bool should_rotate() const;
 
    void perform_rotation();
 
    std::string generate_rotated_filename(int index = -1) const;
 
    void cleanup_old_files();
 
    std::vector<std::string> get_backup_files() const;
 
    bool should_rotate_by_time() const;
 
    std::size_t get_file_size() const;
 
private:
    rotation_type rotation_type_;
    size_t max_size_;
    size_t max_files_;
    size_t check_interval_;           
    size_t writes_since_check_{0};    
    std::string base_filename_;
    std::string file_extension_;
    std::chrono::system_clock::time_point last_rotation_time_;
    std::chrono::system_clock::time_point current_period_start_;
};
 
} // namespace kcenon::logger