#include <rotating_file_sink.h>

Inheritance diagram for spdlog::sinks::rotating_file_sink< Mutex >:

Public Member Functions
	rotating_file_sink (filename_t base_filename, std::size_t max_size, std::size_t max_files)

Public Member Functions inherited from spdlog::sinks::base_sink< Mutex >
	base_sink ()=default

	base_sink (const base_sink &)=delete

base_sink &	operator= (const base_sink &)=delete

void	log (const details::log_msg &msg) final

void	flush () final

void	set_pattern (const std::string &pattern) final

void	set_formatter (std::unique_ptr< spdlog::formatter > sink_formatter) final

Public Member Functions inherited from spdlog::sinks::sink
	sink ()

	sink (std::unique_ptr< spdlog::pattern_formatter > formatter)

virtual	~sink ()=default

bool	should_log (level::level_enum msg_level) const

void	set_level (level::level_enum log_level)

level::level_enum	level () const

Static Public Member Functions
static filename_t	calc_filename (const filename_t &filename, std::size_t index)

Protected Member Functions
void	sink_it_ (const details::log_msg &msg) override

void	flush_ () override

Protected Member Functions inherited from spdlog::sinks::base_sink< Mutex >
virtual void	set_pattern_ (const std::string &pattern)

virtual void	set_formatter_ (std::unique_ptr< spdlog::formatter > sink_formatter)

Private Member Functions
void	rotate_ ()

bool	rename_file (const filename_t &src_filename, const filename_t &target_filename)

Private Attributes
filename_t	base_filename_

std::size_t	max_size_

std::size_t	max_files_

std::size_t	current_size_

details::file_helper	file_helper_

Additional Inherited Members
Protected Attributes inherited from spdlog::sinks::base_sink< Mutex >
Mutex	mutex_

Protected Attributes inherited from spdlog::sinks::sink
level_t	level_

std::unique_ptr< spdlog::formatter >	formatter_

Detailed Description

template<typename Mutex>
class spdlog::sinks::rotating_file_sink< Mutex >

Definition at line 31 of file rotating_file_sink.h.

Constructor & Destructor Documentation

template<typename Mutex >

spdlog::sinks::rotating_file_sink< Mutex >::rotating_file_sink	(	filename_t	base_filename,
		std::size_t	max_size,
		std::size_t	max_files
	)

inline

Definition at line 34 of file rotating_file_sink.h.

         : base_filename_(std::move(base_filename))
         , max_size_(max_size)
         , max_files_(max_files)
     {
         file_helper_.open(calc_filename(base_filename_, 0));
         current_size_ = file_helper_.size(); // expensive. called only once
     }

Member Function Documentation

template<typename Mutex >

static filename_t spdlog::sinks::rotating_file_sink< Mutex >::calc_filename	(	const filename_t &	filename,
		std::size_t	index
	)

inlinestatic

Definition at line 45 of file rotating_file_sink.h.

     {
         typename std::conditional<std::is_same<filename_t::value_type, char>::value, fmt::memory_buffer, fmt::wmemory_buffer>::type w;
         if (index != 0u)
         {
             filename_t basename, ext;
             std::tie(basename, ext) = details::file_helper::split_by_extension(filename);
             fmt::format_to(w, SPDLOG_FILENAME_T("{}.{}{}"), basename, index, ext);
         }
         else
         {
             fmt::format_to(w, SPDLOG_FILENAME_T("{}"), filename);
         }
         return fmt::to_string(w);
     }

template<typename Mutex >

void spdlog::sinks::rotating_file_sink< Mutex >::flush_ ( )

inlineoverrideprotectedvirtual

Implements spdlog::sinks::base_sink< Mutex >.

Definition at line 75 of file rotating_file_sink.h.

     {
         file_helper_.flush();
     }

template<typename Mutex >

bool spdlog::sinks::rotating_file_sink< Mutex >::rename_file	(	const filename_t &	src_filename,
		const filename_t &	target_filename
	)

inlineprivate

Definition at line 119 of file rotating_file_sink.h.

     {
         // try to delete the target file in case it already exists.
         (void)details::os::remove(target_filename);
         return details::os::rename(src_filename, target_filename) == 0;
     }

template<typename Mutex >

void spdlog::sinks::rotating_file_sink< Mutex >::rotate_ ( )

inlineprivate

Definition at line 86 of file rotating_file_sink.h.

     {
         using details::os::filename_to_str;
         file_helper_.close();
         for (auto i = max_files_; i > 0; --i)
         {
             filename_t src = calc_filename(base_filename_, i - 1);
             if (!details::file_helper::file_exists(src))
             {
                 continue;
             }
             filename_t target = calc_filename(base_filename_, i);
 
             if (!rename_file(src, target))
             {
                 // if failed try again after a small delay.
                 // this is a workaround to a windows issue, where very high rotation
                 // rates can cause the rename to fail with permission denied (because of antivirus?).
                 details::os::sleep_for_millis(100);
                 if (!rename_file(src, target))
                 {
                     file_helper_.reopen(true); // truncate the log file anyway to prevent it to grow beyond its limit!
                     current_size_ = 0;
                     throw spdlog_ex(
                         "rotating_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno);
                 }
             }
         }
         file_helper_.reopen(true);
     }

template<typename Mutex >

void spdlog::sinks::rotating_file_sink< Mutex >::sink_it_ ( const details::log_msg & msg )

inlineoverrideprotectedvirtual

Implements spdlog::sinks::base_sink< Mutex >.

Definition at line 62 of file rotating_file_sink.h.

     {
         fmt::memory_buffer formatted;
         sink::formatter_->format(msg, formatted);
         current_size_ += formatted.size();
         if (current_size_ > max_size_)
         {
             rotate_();
             current_size_ = formatted.size();
         }
         file_helper_.write(formatted);
     }

Member Data Documentation

template<typename Mutex >

filename_t spdlog::sinks::rotating_file_sink< Mutex >::base_filename_

private

Definition at line 126 of file rotating_file_sink.h.

template<typename Mutex >

std::size_t spdlog::sinks::rotating_file_sink< Mutex >::current_size_

private

Definition at line 129 of file rotating_file_sink.h.

template<typename Mutex >

details::file_helper spdlog::sinks::rotating_file_sink< Mutex >::file_helper_

private

Definition at line 130 of file rotating_file_sink.h.

template<typename Mutex >

std::size_t spdlog::sinks::rotating_file_sink< Mutex >::max_files_

private

Definition at line 128 of file rotating_file_sink.h.

template<typename Mutex >

std::size_t spdlog::sinks::rotating_file_sink< Mutex >::max_size_

private

Definition at line 127 of file rotating_file_sink.h.

The documentation for this class was generated from the following file:

wire-cell-build/util/inc/spdlog/sinks/rotating_file_sink.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename Mutex> class spdlog::sinks::rotating_file_sink< Mutex >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename Mutex>
class spdlog::sinks::rotating_file_sink< Mutex >