logger.hpp
13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
/*
* @Author: yangzilong
* @Date: 2021-12-21 11:07:11
* @Last Modified by: yangzilong
* @Email: yangzilong@objecteye.com
* @Description:
*/
#pragma once
// #include "define.hpp"
#include <spdlog/spdlog.h>
#include <spdlog/common.h>
#include <spdlog/details/file_helper.h>
#include <spdlog/details/null_mutex.h>
#include <spdlog/fmt/fmt.h>
#include <spdlog/sinks/base_sink.h>
#include <spdlog/details/os.h>
#include <spdlog/details/circular_q.h>
#include <spdlog/details/synchronous_factory.h>
#include <set>
#include <chrono>
#include <cstdio>
#include <ctime>
#include <mutex>
#include <string>
#include <memory>
#include <vector>
#define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
#define LOG_TRACE_WITH_LOGGER(logger, ...) {SPDLOG_LOGGER_TRACE(logger, __VA_ARGS__);}
#define LOG_DEBUG_WITH_LOGGER(logger, ...) {SPDLOG_LOGGER_DEBUG(logger, __VA_ARGS__);}
#define LOG_WARN_WITH_LOGGER(logger, ...) {SPDLOG_LOGGER_WARN(logger, __VA_ARGS__);}
#define LOG_ERROR_WITH_LOGGER(logger, ...) {SPDLOG_LOGGER_ERROR(logger, __VA_ARGS__);}
#define LOG_INFO_WITH_LOGGER(logger, ...) {SPDLOG_LOGGER_INFO(logger, __VA_ARGS__);}
#define LOG_CRITICAL_WITH_LOGGER(logger, ...) {SPDLOG_LOGGER_CRITICAL(logger, __VA_ARGS__);}
// use fmt lib, e.g. LOG_WARN("warn log, {1}, {1}, {2}", 1, 2);
#define LOG_TRACE(msg, ...) spdlog::log({__FILENAME__, __LINE__, __FUNCTION__}, spdlog::level::trace, msg, ##__VA_ARGS__)
#define LOG_DEBUG(msg, ...) spdlog::log({__FILENAME__, __LINE__, __FUNCTION__}, spdlog::level::debug, msg, ##__VA_ARGS__)
#define LOG_INFO(msg,...) spdlog::log({__FILENAME__, __LINE__, __FUNCTION__}, spdlog::level::info, msg, ##__VA_ARGS__)
#define LOG_WARN(msg,...) spdlog::log({__FILENAME__, __LINE__, __FUNCTION__}, spdlog::level::warn, msg, ##__VA_ARGS__)
#define LOG_ERROR(msg,...) spdlog::log({__FILENAME__, __LINE__, __FUNCTION__}, spdlog::level::err, msg, ##__VA_ARGS__)
#define LOG_FATAL(msg,...) spdlog::log({__FILENAME__, __LINE__, __FUNCTION__}, spdlog::level::critical, msg, ##__VA_ARGS__)
namespace spdlog
{
namespace sinks
{
template<typename Mutex>
class easy_file_sink final : public base_sink<Mutex>
{
public:
easy_file_sink(filename_t base_filename, size_t max_size, size_t max_keep_days = 0)
: base_filename_(std::move(base_filename))
, max_size_(max_size)
, max_keep_days_(max_keep_days)
{
auto now = log_clock::now();
auto filename = gen_filename_by_daliy(base_filename_, now_tm(now));
file_helper_.open(filename, false);
current_size_ = file_helper_.size();
rotation_tp_ = next_rotation_tp_();
if (max_keep_days_ > 0)
{
filespath_q_.push_back(std::move(std::set<filename_t>()));
filespath_q_[filespath_q_.size() - 1].insert(filename);
}
}
filename_t filename()
{
std::lock_guard<Mutex> lock(base_sink<Mutex>::mutex_);
return file_helper_.filename();
}
protected:
void sink_it_(const details::log_msg &msg) override
{
memory_buf_t formatted;
base_sink<Mutex>::formatter_->format(msg, formatted);
current_size_ += formatted.size();
auto time = msg.time;
if (time >= rotation_tp_)
{
file_helper_.close();
auto filename = gen_filename_by_daliy(base_filename_, now_tm(time));
file_helper_.open(filename, false);
current_size_ = file_helper_.size();
rotation_tp_ = next_rotation_tp_();
{
filespath_q_.push_back(std::move(std::set<filename_t>()));
filespath_q_[filespath_q_.size() - 1].emplace(filename);
}
// Do the cleaning only at the end because it might throw on failure.
if (max_keep_days_ > 0 && filespath_q_.size() > max_keep_days_)
delete_old_();
}
else if (current_size_ >= max_size_)
{
file_helper_.close();
auto src_name = gen_filename_by_daliy(base_filename_, now_tm(time));
auto target_name = gen_filename_by_filesize(base_filename_, now_tm(time), filespath_q_[filespath_q_.size() - 1].size());
// rename file if failed then us `target_name` as src_name.
if (!rename_file_(src_name, target_name))
{
details::os::sleep_for_millis(200);
if (!rename_file_(src_name, target_name))
{
fprintf(stderr, "%s:%d rename %s to %s failed\n", __FILENAME__, __LINE__, src_name.c_str(), target_name.c_str());
src_name = target_name;
}
}
filespath_q_[filespath_q_.size() - 1].emplace(src_name);
if (src_name != target_name)
filespath_q_[filespath_q_.size() - 1].emplace(target_name);
file_helper_.open(src_name, false);
current_size_ = file_helper_.size();
rotation_tp_ = next_rotation_tp_();
}
file_helper_.write(formatted);
}
void flush_() override
{
file_helper_.flush();
}
private:
tm now_tm(log_clock::time_point tp)
{
time_t tnow = log_clock::to_time_t(tp);
return spdlog::details::os::localtime(tnow);
}
/**
* @brief Get next day tm.
*
* @return log_clock::time_point
*/
log_clock::time_point next_rotation_tp_()
{
auto now = log_clock::now();
tm date = now_tm(now);
date.tm_hour = 0;
date.tm_min = 0;
date.tm_sec = 0;
auto rotation_time = log_clock::from_time_t(std::mktime(&date));
if (rotation_time > now)
return rotation_time;
return {rotation_time + std::chrono::hours(24)};
}
// Delete the file N rotations ago.
// Throw spdlog_ex on failure to delete the old file.
void delete_old_()
{
for (auto iter = filespath_q_.begin(); iter != filespath_q_.end();)
{
if (filespath_q_.size() <= max_keep_days_)
break;
for (auto it = iter->begin(); it != iter->end(); ++it)
{
bool ok = details::os::remove_if_exists(*it) == 0;
if (!ok)
throw_spdlog_ex("Failed removing daily file " + details::os::filename_to_str(*it), errno);
}
filespath_q_.erase(iter);
}
}
/* */
static filename_t gen_filename_by_daliy(const filename_t &filename, const tm &now_tm)
{
filename_t basename, ext;
std::tie(basename, ext) = details::file_helper::split_by_extension(filename);
return fmt::format(SPDLOG_FILENAME_T("{}_{:04d}_{:02d}_{:02d}{}"),
basename,
now_tm.tm_year + 1900,
now_tm.tm_mon + 1,
now_tm.tm_mday,
ext);
}
//
static filename_t gen_filename_by_filesize(const filename_t &filename, const tm &now_tm, const int &idx)
{
filename_t basename, ext;
std::tie(basename, ext) = details::file_helper::split_by_extension(filename);
return fmt::format(SPDLOG_FILENAME_T("{}_{:04d}_{:02d}_{:02d}_{:02d}{:02d}{:02d}.{:d}{}"),
basename,
now_tm.tm_year + 1900,
now_tm.tm_mon + 1,
now_tm.tm_mday,
now_tm.tm_hour,
now_tm.tm_min,
now_tm.tm_sec,
idx,
ext);
}
static bool rename_file_(const filename_t &src_filename, const filename_t &target_filename)
{
(void)details::os::remove(target_filename);
return details::os::rename(src_filename, target_filename) == 0;
}
filename_t base_filename_;
log_clock::time_point rotation_tp_;
details::file_helper file_helper_;
std::size_t max_size_;
std::size_t max_keep_days_;
std::size_t current_size_;
// std::vector<<std::set<filename_t>> filespath_q_;
std::vector<std::set<filename_t>> filespath_q_;
};
using easy_file_sink_mt = easy_file_sink<std::mutex>;
using easy_file_sink_st = easy_file_sink<details::null_mutex>;
} // namespace sinks
template<typename Factory = spdlog::synchronous_factory>
inline std::shared_ptr<logger> easy_logger_mt(
const std::string &logger_name, const filename_t &filename, size_t max_size, size_t max_keep_days = -1)
{
return Factory::template create<sinks::easy_file_sink_mt>(logger_name, filename, max_size, max_keep_days);
}
template<typename Factory = spdlog::synchronous_factory>
inline std::shared_ptr<logger> easy_logger_st(
const std::string &logger_name, const filename_t &filename, size_t max_size, size_t max_keep_days = -1)
{
return Factory::template create<sinks::easy_file_sink_st>(logger_name, filename, max_size, max_keep_days);
}
} // namespace spdlog
enum class LogLevel
{
CLOSE = -1,
TRACE = 0,
DEBUG = 1,
INFO = 2,
WARN = 3,
ERROR = 4,
FATAL = 5,
};
class LoggerGenerator
{
public:
static LoggerGenerator* get_instance()
{
static LoggerGenerator logger;
return &logger;
}
void destory(LoggerGenerator *ptr)
{
if (ptr != nullptr)
{
delete ptr;
ptr = nullptr;
}
}
std::shared_ptr<spdlog::logger> gen_logger(const LogLevel &level, const std::string &logger_name,
const std::string &file_path, size_t max_file_size, size_t max_keep_days)
{
spdlog::level::level_enum spd_level;
if (LogLevel::TRACE == level)
spd_level = spdlog::level::trace;
else if (LogLevel::DEBUG == level)
spd_level = spdlog::level::debug;
else if (LogLevel::INFO == level)
spd_level = spdlog::level::info;
else if (LogLevel::WARN == level)
spd_level = spdlog::level::warn;
else if (LogLevel::ERROR == level)
spd_level = spdlog::level::err;
else if (LogLevel::FATAL == level)
spd_level = spdlog::level::critical;
else if (LogLevel::CLOSE == level)
spd_level = spdlog::level::off;
auto sink_ptr = std::make_shared<spdlog::sinks::easy_file_sink_mt>(file_path, max_file_size, max_keep_days);
auto logger = std::make_shared<spdlog::logger>(logger_name, sink_ptr);
logger->set_level(spd_level);
logger->set_pattern("%s(%#): [%L %D %T.%e %P %t %!] %v");
return logger;
}
void set_default_logger(const LogLevel &level, const std::string &logger_name,
const std::string &file_name, size_t max_file_size, size_t max_keep_days)
{
auto logger = gen_logger(level, logger_name, file_name, max_file_size, max_keep_days);
spdlog::set_default_logger(logger);
spdlog::set_level(logger->level());
spdlog::set_pattern("%s(%#): [%L %D %T.%e %P %t %!] %v");
spdlog::flush_on(spdlog::level::trace);
spdlog::flush_every(std::chrono::seconds(1));
}
};
static void set_default_logger(const LogLevel &level, const std::string &logger_name,
const std::string &file_path, size_t max_file_size, size_t max_keep_days)
{
static LoggerGenerator loggerGenerator;
loggerGenerator.set_default_logger(level, logger_name, file_path, max_file_size, max_keep_days);
}
static std::shared_ptr<spdlog::logger> get_simple_logger(const LogLevel &level, const std::string &logger_name,
const std::string &file_path, size_t max_file_size, size_t max_keep_days)
{
static LoggerGenerator loggerGenerator;
return loggerGenerator.gen_logger(level, logger_name, file_path, max_file_size, max_keep_days);
}