From 5c1951acec415464751c7843a4e2bec81785b194 Mon Sep 17 00:00:00 2001 From: puasonych Date: Fri, 25 May 2018 22:20:14 +0500 Subject: [PATCH] Update step_file_sink Fixed adding a file header and adding ignoring of empty files --- include/spdlog/contrib/sinks/step_file_sink.h | 70 ++++++++++++------- 1 file changed, 43 insertions(+), 27 deletions(-) diff --git a/include/spdlog/contrib/sinks/step_file_sink.h b/include/spdlog/contrib/sinks/step_file_sink.h index 395a534d..f88b7566 100644 --- a/include/spdlog/contrib/sinks/step_file_sink.h +++ b/include/spdlog/contrib/sinks/step_file_sink.h @@ -18,22 +18,22 @@ // Create a file logger which creates new files with a specified time step and fixed file size: // // std::shared_ptr step_logger_mt(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, const -// filename_t &tmp_ext = ".tmp", unsigned max_file_size = std::numeric_limits::max()); std::shared_ptr +// filename_t &tmp_ext = ".tmp", unsigned max_file_size = std::numeric_limits::max(), bool delete_empty_files = true, const filename_t &file_header = ""); std::shared_ptr // step_logger_st(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, const filename_t &tmp_ext = ".tmp", // unsigned max_file_size = std::numeric_limits::max()); // Example for spdlog_impl.h // Create a file logger that creates new files with a specified increment // inline std::shared_ptr spdlog::step_logger_mt( -// const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, const filename_t &tmp_ext, unsigned max_file_size) +// const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, const filename_t &tmp_ext, unsigned max_file_size, bool delete_empty_files, const filename_t &file_header) // { -// return create(logger_name, filename_fmt, seconds, tmp_ext, max_file_size); +// return create(logger_name, filename_fmt, seconds, tmp_ext, max_file_size, delete_empty_files, file_header); // } // inline std::shared_ptr spdlog::step_logger_st( -// const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, const filename_t &tmp_ext, unsigned max_file_size) +// const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, const filename_t &tmp_ext, unsigned max_file_size, bool delete_empty_files, const filename_t &file_header) // { -// return create(logger_name, filename_fmt, seconds, tmp_ext, max_file_size); +// return create(logger_name, filename_fmt, seconds, tmp_ext, max_file_size, delete_empty_files, file_header); // } namespace spdlog { @@ -57,31 +57,19 @@ struct default_step_file_name_calculator } }; -/* - * The default action when recording starts - */ -struct default_action_when_recording_starts -{ - // Write the start message to the beginning of the file and return its size - static size_t beginning_of_file() - { - return 0; - } -}; - /* * Rotating file sink based on size and a specified time step */ -template +template class step_file_sink SPDLOG_FINAL : public base_sink { public: - step_file_sink(filename_t base_filename, unsigned step_seconds, filename_t tmp_ext, unsigned max_size) + step_file_sink(filename_t base_filename, unsigned step_seconds, filename_t tmp_ext, unsigned max_size, bool delete_empty_files, filename_t file_header) : _base_filename(std::move(base_filename)) , _tmp_ext(std::move(tmp_ext)) , _step_seconds(step_seconds) , _max_size(max_size) + , _delete_empty_files(delete_empty_files) { if (step_seconds == 0) { @@ -100,8 +88,18 @@ public: throw spdlog_ex("step_file_sink: The temporary extension matches the specified in ctor"); } + if (!file_header.empty()) + { + pattern_formatter formatter_for_file_header("%v"); + _file_header.raw << file_header; + formatter_for_file_header.format(_file_header); + } + _file_helper.open(_current_filename); _current_size = _file_helper.size(); // expensive. called only once + + _current_size += _file_header.formatted.size(); + if (_current_size) _file_helper.write(_file_header); } ~step_file_sink() @@ -118,16 +116,21 @@ public: protected: void _sink_it(const details::log_msg &msg) override { - _current_size += msg.formatted.size(); - if (std::chrono::system_clock::now() >= _tp || _current_size > _max_size) + auto msg_size = msg.formatted.size(); + + if (std::chrono::system_clock::now() >= _tp || _current_size + msg_size > _max_size) { close_current_file(); std::tie(_current_filename, std::ignore) = FileNameCalc::calc_filename(_base_filename, _tmp_ext); _file_helper.open(_current_filename); _tp = _next_tp(); - _current_size = msg.formatted.size() + RecordingStartActions::beginning_of_file(); + + _current_size = _file_header.formatted.size(); + if (_current_size) _file_helper.write(_file_header); } + + _current_size += msg_size; _file_helper.write(msg); } @@ -146,13 +149,24 @@ private: { using details::os::filename_to_str; - filename_t src = _current_filename, target; - std::tie(target, std::ignore) = details::file_helper::split_by_extenstion(src); + // Delete empty files, if required + if (_delete_empty_files && _current_size <= _file_header.formatted.size()) + { + if (details::os::remove(_current_filename) != 0) + { + throw spdlog_ex("step_file_sink: not remove " + filename_to_str(_current_filename), errno); + } + + return; + } + + filename_t target; + std::tie(target, std::ignore) = details::file_helper::split_by_extenstion(_current_filename); target += _ext; - if (details::file_helper::file_exists(src) && details::os::rename(src, target) != 0) + if (details::file_helper::file_exists(_current_filename) && details::os::rename(_current_filename, target) != 0) { - throw spdlog_ex("step_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno); + throw spdlog_ex("step_file_sink: failed renaming " + filename_to_str(_current_filename) + " to " + filename_to_str(target), errno); } } @@ -160,6 +174,7 @@ private: const filename_t _tmp_ext; const std::chrono::seconds _step_seconds; const unsigned _max_size; + const bool _delete_empty_files; std::chrono::system_clock::time_point _tp; filename_t _current_filename; @@ -167,6 +182,7 @@ private: unsigned _current_size; details::file_helper _file_helper; + details::log_msg _file_header; }; using step_file_sink_mt = step_file_sink;