Easylogging++的使用及擴展

2021 年 8 月 19 日
筆記
C++

簡介
使用
擴展
源程式碼優化（不推薦）
附件

簡介

Easylogging++ 是用於 C++ 應用程式的單頭高效日誌庫。它非常強大，高度可擴展並且可以根據用戶的要求進行配置。github鏈接：//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函數的實現時，記得修改頭文件裡面的定義和所有該函數的調用。不推薦直接修改源程式碼，修改源程式碼不利於後期的版本更新。

附件

Tags: C++

Easylogging++的使用及擴展

簡介

使用

擴展

配置日誌路徑

時間滾動日誌

自動刪除日誌

封裝到一個頭文件

源程式碼優化（不推薦）

附件

VirMach 便宜 VPS

QNews

Easylogging++的使用及擴展

簡介

使用

擴展

配置日誌路徑

時間滾動日誌

自動刪除日誌

封裝到一個頭文件

源程式碼優化（不推薦）

附件

分享此文：

Related Posts

從零搭建分散式文件系統MinIO比FastDFS要更合適

第2-1-5章 docker安裝MinIO實現文件存儲服務-springboot整合minio-minio全網最全的資料

ACM學習筆記：可持久化線段樹

Elasticsearch核心技術（二）：Elasticsearch入門

VirMach 便宜 VPS

QNews

熱門搜尋