Easylogging++的使用及扩展
简介
Easylogging++ 是用于 C++ 应用程序的单头高效日志库。它非常强大，高度可扩展并且可以根据用户的要求进行配置。github链接：https://github.com/amrayn/easyloggingpp。
Easylogging++ 在v9.89版只有一个头文件，之后改为一个头文件、一个源文件，目前最新版本是v9.97（本文使用的版本）。
使用
使用 Easylogging++只需要三个简单的步骤：
- 下载最新版本
- 将easylogging++.h和easylogging++.cc包含到项目中
- 使用单个宏进行初始化
#include "easylogging++.h"
INITIALIZE_EASYLOGGINGPP
int main(int argc, char* argv[]) {
LOG(INFO) << "My first info log using default logger";
return 0;
}
扩展
Easylogging++默认日志写在一个文件里面，而且没有按日期新建日志的功能，需要自己扩展一下。扩展功能如下：
- 日志文件放在按年、月生成的文件夹内，每个日志级别单独一个日志文件，如“Log\2021\202108\20210818_INFO.log”
- 每天生成新的日志文件，即日志文件按日期滚动
- 根据日志文件的最后修改时间自动删除n天前的日志文件，仅支持Windows系统
我会尽量使用标准库和Easylogging++里面已有的功能来实现扩展功能，减少外部依赖项，也便于后面进行命名空间的合并。
配置日志路径
Easylogging++支持配置文件、程序代码两种方式配置日志路径，这里采用程序代码的方式配置日志路径，代码如下：
static std::string LogRootPath = "D:\\Log";
static el::base::SubsecondPrecision LogSsPrec(3);
static std::string LoggerToday = el::base::utils::DateTime::getDateTime("%Y%M%d", &LogSsPrec);
static void ConfigureLogger()
{
std::string datetimeY = el::base::utils::DateTime::getDateTime("%Y", &LogSsPrec);
std::string datetimeYM = el::base::utils::DateTime::getDateTime("%Y%M", &LogSsPrec);
std::string datetimeYMd = el::base::utils::DateTime::getDateTime("%Y%M%d", &LogSsPrec);
std::string filePath = LogRootPath + "\\" + datetimeY + "\\" + datetimeYM + "\\";
std::string filename;
el::Configurations defaultConf;
defaultConf.setToDefault();
//建议使用setGlobally
defaultConf.setGlobally(el::ConfigurationType::Format, "%datetime %msg");
defaultConf.setGlobally(el::ConfigurationType::Enabled, "true");
defaultConf.setGlobally(el::ConfigurationType::ToFile, "true");
defaultConf.setGlobally(el::ConfigurationType::ToStandardOutput, "true");
defaultConf.setGlobally(el::ConfigurationType::SubsecondPrecision, "6");
defaultConf.setGlobally(el::ConfigurationType::PerformanceTracking, "true");
defaultConf.setGlobally(el::ConfigurationType::LogFlushThreshold, "1");
//限制文件大小时配置
//defaultConf.setGlobally(el::ConfigurationType::MaxLogFileSize, "2097152");
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Global)+".log";
defaultConf.set(el::Level::Global, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Debug) + ".log";
defaultConf.set(el::Level::Debug, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Error) + ".log";
defaultConf.set(el::Level::Error, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Fatal) + ".log";
defaultConf.set(el::Level::Fatal, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Info) + ".log";
defaultConf.set(el::Level::Info, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Trace) + ".log";
defaultConf.set(el::Level::Trace, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Warning) + ".log";
defaultConf.set(el::Level::Warning, el::ConfigurationType::Filename, filePath + filename);
el::Loggers::reconfigureLogger("default", defaultConf);
//限制文件大小时启用
//el::Loggers::addFlag(el::LoggingFlag::StrictLogFileSizeCheck);
}
如果想软件每个功能模块生成自己的日志，可以参考上面的代码自己实现，实现时注意以下两点：
- 使用“%Y%M”配置文件路径时，Easylogging++只会识别第一个格式符，如“\%datetime{%Y%M}\%datetime{%Y%M}”生成的路径是“\202108\%datetime{%Y%M}”。
- Easylogging++目前不支持文件名中加入日志级别，需要自己实现，如“\%datetime{%Y%M}%level.log”生成的路径是“\202108%level.log”。
这些问题可以按我上面的方法避开，或者修改源代码进行修复，源代码的修改部分会放在文章最后。
时间滚动日志
Easylogging++没有按时间滚动日志的功能，该功能需要检查当前的时间并决定是否生成新日志文件（文件名必须包含时间信息），关键问题只有两个：
- 检查时间的时机：选择在每条日志写之前检查一次，因此需要监控每条日志的写入。
- 生成新日志文件：直接调用上面的“ConfigureLogger()”方法覆盖日志的配置即可。
注：如果使用定时器来检查当前时间，修改系统时间时日志文件无法及时更新。
监控每条日志的写入需要实现一个继承LogDispatchCallback的类，代码如下：
class LogDispatcher : public el::LogDispatchCallback
{
protected:
void handle(const el::LogDispatchData* data) noexcept override {
m_data = data;
// 使用记录器的默认日志生成器进行调度
dispatch(m_data->logMessage()->logger()->logBuilder()->build(m_data->logMessage(),
m_data->dispatchAction() == el::base::DispatchAction::NormalLog));
//此处也可以写入数据库
}
private:
const el::LogDispatchData* m_data;
void dispatch(el::base::type::string_t&& logLine) noexcept
{
el::base::SubsecondPrecision ssPrec(3);
static std::string now = el::base::utils::DateTime::getDateTime("%Y%M%d", &ssPrec);
if (now != LoggerToday)
{
LoggerToday= now;
ConfigureLogger();
}
}
};
LogDispatcher的使用方法如下：
el::Helpers::installLogDispatchCallback<LogDispatcher>("LogDispatcher");
LogDispatcher* dispatcher = el::Helpers::logDispatchCallback<LogDispatcher>("LogDispatcher");
dispatcher->setEnabled(true);
自动删除日志
自动删除日志文件夹下最后修改时间在n天前的日志，代码如下：
//删除文件路径下n天前的日志文件，由于删除日志文件导致的空文件夹会在下一次删除
//isRoot为true时，只会清理空的子文件夹
void DeleteOldFiles(std::string path, int oldDays, bool isRoot)
{
// 基于当前系统的当前日期/时间
time_t nowTime = time(0);
//文件句柄
intptr_t hFile = 0;
//文件信息
struct _finddata_t fileinfo;
//文件扩展名
std::string extName = ".log";
std::string str;
//是否是空文件夹
bool isEmptyFolder = true;
if ((hFile = _findfirst(str.assign(path).append("\\*").c_str(), &fileinfo)) != -1)
{
do
{
//如果是目录,迭代之
//如果不是,检查文件
if ((fileinfo.attrib & _A_SUBDIR))
{
if (strcmp(fileinfo.name, ".") != 0 && strcmp(fileinfo.name, "..") != 0)
{
isEmptyFolder = false;
DeleteOldFiles(str.assign(path).append("\\").append(fileinfo.name), oldDays, false);
}
}
else
{
isEmptyFolder = false;
str.assign(fileinfo.name);
if ((str.size() >= extName.size()) && (str.substr(str.size() - extName.size()) == extName))
{
//是日志文件
if ((nowTime - fileinfo.time_write) / (24 * 3600) > oldDays)
{
str.assign(path).append("\\").append(fileinfo.name);
system(("attrib -H -R " + str).c_str());
system(("del/q " + str).c_str());
}
}
}
} while (_findnext(hFile, &fileinfo) == 0);
_findclose(hFile);
if (isEmptyFolder && (!isRoot))
{
system(("attrib -H -R " + path).c_str());
system(("rd/q " + path).c_str());
}
}
}
里面的删除操作是通过调用批处理命令实现，网上有一个自动删除过期文件的完整批处理命令，不过我从来没成功过。
可以在每天新建日志文件时调用删除方法，删除文件可能会耗费一些时间，最好重新开一个线程，代码如下：
static int LogCleanDays = 30;
std::thread task(el::DeleteOldFiles, LogRootPath, LogCleanDays, true);
封装到一个头文件
上面的代码比较分散，实际使用时可以全部放到“easylogginghelper.h”头文件中，然后在项目中引用。头文件提供一个初始化函数“InitEasylogging()”来初始化所有配置，头文件代码如下：
#pragma once
#ifndef EASYLOGGINGHELPER_H
#define EASYLOGGINGHELPER_H
#include "easylogging++.h"
#include <io.h>
#include <thread>
INITIALIZE_EASYLOGGINGPP
namespace el
{
static int LogCleanDays = 30;
static std::string LogRootPath = "D:\\Log";
static el::base::SubsecondPrecision LogSsPrec(3);
static std::string LoggerToday = el::base::utils::DateTime::getDateTime("%Y%M%d", &LogSsPrec);
//删除文件路径下n天前的日志文件，由于删除日志文件导致的空文件夹会在下一次删除
//isRoot为true时，只会清理空的子文件夹
void DeleteOldFiles(std::string path, int oldDays, bool isRoot)
{
// 基于当前系统的当前日期/时间
time_t nowTime = time(0);
//文件句柄
intptr_t hFile = 0;
//文件信息
struct _finddata_t fileinfo;
//文件扩展名
std::string extName = ".log";
std::string str;
//是否是空文件夹
bool isEmptyFolder = true;
if ((hFile = _findfirst(str.assign(path).append("\\*").c_str(), &fileinfo)) != -1)
{
do
{
//如果是目录,迭代之
//如果不是,检查文件
if ((fileinfo.attrib & _A_SUBDIR))
{
if (strcmp(fileinfo.name, ".") != 0 && strcmp(fileinfo.name, "..") != 0)
{
isEmptyFolder = false;
DeleteOldFiles(str.assign(path).append("\\").append(fileinfo.name), oldDays, false);
}
}
else
{
isEmptyFolder = false;
str.assign(fileinfo.name);
if ((str.size() > extName.size()) && (str.substr(str.size() - extName.size()) == extName))
{
//是日志文件
if ((nowTime - fileinfo.time_write) / (24 * 3600) > oldDays)
{
str.assign(path).append("\\").append(fileinfo.name);
system(("attrib -H -R " + str).c_str());
system(("del/q " + str).c_str());
}
}
}
} while (_findnext(hFile, &fileinfo) == 0);
_findclose(hFile);
if (isEmptyFolder && (!isRoot))
{
system(("attrib -H -R " + path).c_str());
system(("rd/q " + path).c_str());
}
}
}
static void ConfigureLogger()
{
std::string datetimeY = el::base::utils::DateTime::getDateTime("%Y", &LogSsPrec);
std::string datetimeYM = el::base::utils::DateTime::getDateTime("%Y%M", &LogSsPrec);
std::string datetimeYMd = el::base::utils::DateTime::getDateTime("%Y%M%d", &LogSsPrec);
std::string filePath = LogRootPath + "\\" + datetimeY + "\\" + datetimeYM + "\\";
std::string filename;
el::Configurations defaultConf;
defaultConf.setToDefault();
//建议使用setGlobally
defaultConf.setGlobally(el::ConfigurationType::Format, "%datetime %msg");
defaultConf.setGlobally(el::ConfigurationType::Enabled, "true");
defaultConf.setGlobally(el::ConfigurationType::ToFile, "true");
defaultConf.setGlobally(el::ConfigurationType::ToStandardOutput, "true");
defaultConf.setGlobally(el::ConfigurationType::SubsecondPrecision, "6");
defaultConf.setGlobally(el::ConfigurationType::PerformanceTracking, "true");
defaultConf.setGlobally(el::ConfigurationType::LogFlushThreshold, "1");
//限制文件大小时配置
//defaultConf.setGlobally(el::ConfigurationType::MaxLogFileSize, "2097152");
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Global)+".log";
defaultConf.set(el::Level::Global, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Debug) + ".log";
defaultConf.set(el::Level::Debug, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Error) + ".log";
defaultConf.set(el::Level::Error, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Fatal) + ".log";
defaultConf.set(el::Level::Fatal, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Info) + ".log";
defaultConf.set(el::Level::Info, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Trace) + ".log";
defaultConf.set(el::Level::Trace, el::ConfigurationType::Filename, filePath + filename);
filename = datetimeYMd + "_" + el::LevelHelper::convertToString(el::Level::Warning) + ".log";
defaultConf.set(el::Level::Warning, el::ConfigurationType::Filename, filePath + filename);
el::Loggers::reconfigureLogger("default", defaultConf);
//限制文件大小时启用
//el::Loggers::addFlag(el::LoggingFlag::StrictLogFileSizeCheck);
}
class LogDispatcher : public el::LogDispatchCallback
{
protected:
void handle(const el::LogDispatchData* data) noexcept override {
m_data = data;
// 使用记录器的默认日志生成器进行调度
dispatch(m_data->logMessage()->logger()->logBuilder()->build(m_data->logMessage(),
m_data->dispatchAction() == el::base::DispatchAction::NormalLog));
//此处也可以写入数据库
}
private:
const el::LogDispatchData* m_data;
void dispatch(el::base::type::string_t&& logLine) noexcept
{
el::base::SubsecondPrecision ssPrec(3);
static std::string now = el::base::utils::DateTime::getDateTime("%Y%M%d", &ssPrec);
if (now != LoggerToday)
{
LoggerToday = now;
ConfigureLogger();
std::thread task(el::DeleteOldFiles, LogRootPath, LogCleanDays, true);
}
}
};
static void InitEasylogging()
{
ConfigureLogger();
el::Helpers::installLogDispatchCallback<LogDispatcher>("LogDispatcher");
LogDispatcher* dispatcher = el::Helpers::logDispatchCallback<LogDispatcher>("LogDispatcher");
dispatcher->setEnabled(true);
}
}
#endif
使用时只需要调用一次“el::InitEasylogging();”即可，代码如下：
#include "easylogging++.h"
#include "easylogginghelper.h"
int main()
{
el::InitEasylogging();
for (size_t i = 0; i < 10000; i++)
{
LOG(TRACE) << "***** trace log *****" << i;
LOG(DEBUG) << "***** debug log *****" << i;
LOG(ERROR) << "***** error log *****" << i;
LOG(WARNING) << "***** warning log *****" << i;
LOG(INFO) << "***** info log *****" << i;
//不要轻易使用，程序会退出
//LOG(FATAL) << "***** fatal log *****" << i;
Sleep(100);
}
}
源代码优化（不推荐）
上面说到Easylogging++只会识别第一个时间格式符且不识别等级格式符，只需要修改TypedConfigurations::resolveFilename函数的实现即可，代码如下：
std::string TypedConfigurations::resolveFilename(Level level,const std::string& filename)
{
std::string resultingFilename = filename;
std::size_t dateIndex = std::string::npos;
std::string dateTimeFormatSpecifierStr = std::string(base::consts::kDateTimeFormatSpecifierForFilename);
//if改为while
while ((dateIndex = resultingFilename.find(dateTimeFormatSpecifierStr.c_str())) != std::string::npos) {
while (dateIndex > 0 && resultingFilename[dateIndex - 1] == base::consts::kFormatSpecifierChar) {
dateIndex = resultingFilename.find(dateTimeFormatSpecifierStr.c_str(), dateIndex + 1);
}
if (dateIndex != std::string::npos) {
const char* ptr = resultingFilename.c_str() + dateIndex;
// Goto end of specifier
ptr += dateTimeFormatSpecifierStr.size();
std::string fmt;
if ((resultingFilename.size() > dateIndex) && (ptr[0] == '{')) {
// User has provided format for date/time
++ptr;
int count = 1; // Start by 1 in order to remove starting brace
std::stringstream ss;
for (; *ptr; ++ptr, ++count) {
if (*ptr == '}') {
++count; // In order to remove ending brace
break;
}
ss << *ptr;
}
//注释掉此语句
//resultingFilename.erase(dateIndex + dateTimeFormatSpecifierStr.size(), count);
fmt = ss.str();
} else {
fmt = std::string(base::consts::kDefaultDateTimeFormatInFilename);
}
base::SubsecondPrecision ssPrec(3);
std::string now = base::utils::DateTime::getDateTime(fmt.c_str(), &ssPrec);
base::utils::Str::replaceAll(now, '/', '-'); // Replace path element since we are dealing with filename
base::utils::Str::replaceAll(resultingFilename, dateTimeFormatSpecifierStr + "{"+ fmt+"}", now);
}
}
//替换等级
base::utils::Str::replaceAll(resultingFilename, base::consts::kSeverityLevelFormatSpecifier, LevelHelper::convertToString(level));
base::utils::Str::replaceAll(resultingFilename, base::consts::kSeverityLevelShortFormatSpecifier, LevelHelper::convertToShortString(level));
return resultingFilename;
}
修改TypedConfigurations::resolveFilename函数的实现时，记得修改头文件里面的定义和所有该函数的调用。不推荐直接修改源代码，修改源代码不利于后期的版本更新。
