簡介
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函式的實現時，記得修改標頭檔案裡面的定義和所有該函式的呼叫。不推薦直接修改原始碼，修改原始碼不利於後期的版本更新。