1. 程式人生 > >c++ 日誌輸出庫 spdlog 簡介(2)

c++ 日誌輸出庫 spdlog 簡介(2)

def 頻率 car ges invalid 輸出日誌 輸出結果 syn else

繼續上一篇,example.cpp解析。

1、set_pattern 自定義日誌格式

官方參考:https://github.com/gabime/spdlog/wiki/3.-Custom-formatting

可以為所有的log制定格式,也可以為指定的log制定格式,註意下面代碼中rotating_logger為指針變量。

auto rotating_logger = spd::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 256, 2);
// Customize msg format for all messages
        spd::set_pattern("
*** [%H:%M:%S %z] [thread %t] %v ***"); rotating_logger->info("This is another message with custom format"); //Customize msg format for a specific logger object: rotating_logger->set_pattern("[%H:%M:%S %f] [thread %t] %v ***");

詳細的格式說明在github上有,在此截圖如下:

技術分享圖片

技術分享圖片

2、set_level 設置日誌級別

低於設置級別的日誌將不會被輸出。各level排序,數值越大級別越高:

// Runtime log levels
        spd::set_level(spd::level::info); //Set global log level to info
        console->debug("This message should not be displayed!");
        console->set_level(spd::level::debug); // Set specific logger‘s log level
        console->debug("This message should be displayed..
");

第一行日誌debug級別低於設定的級別info,在level為info時不會被輸出。

第二行日誌debug級別與設定的級別相同,所以可以顯示出來。

技術分享圖片

typedef enum
{
    trace = 0,
    debug = 1,
    info = 2,
    warn = 3,
    err = 4,
    critical = 5,
    off = 6
} level_enum;

3、編譯階段修改日誌輸出級別 SPDLOG_TRACE 和 SPDLOG_DEBUG

官方參考:https://github.com/gabime/spdlog/wiki/8.-Tweaking

當定義了宏定義 SPDLOG_TRACE_ON 時,可以用SPDLOG_TRACE語句輸出trace級別的log,SPDLOG_DEBUG_ON也是同理。

#define SPDLOG_TRACE_ON
#define SPDLOG_DEBUG_ON
// Compile time log levels
        // define SPDLOG_DEBUG_ON or SPDLOG_TRACE_ON
        SPDLOG_TRACE(console, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23);
        SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23);

需要註意的是,如果不使用set_level命令設置log的輸出級別,默認級別就是info級別,此時即使定義了這兩個宏,debug和trace信息也不會輸出。所以使用時需要先用set_level把級別設為trace才可以。

console->set_level(spd::level::trace); // Set specific logger‘s log level
        // Compile time log levels
        // define SPDLOG_DEBUG_ON or SPDLOG_TRACE_ON
        SPDLOG_TRACE(console, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23);
        SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23);

以下是輸出結果:

技術分享圖片

註意trace和debug的輸出不太一樣,打開spdlog.h,查看SPDLOG_TRACE的定義,可以發現trace中還輸出了文件的位置(“__FILE__”)。

#ifdef SPDLOG_TRACE_ON
#  define SPDLOG_STR_H(x) #x
#  define SPDLOG_STR_HELPER(x) SPDLOG_STR_H(x)
#  ifdef _MSC_VER
#    define SPDLOG_TRACE(logger, ...) logger->trace("[ " __FILE__ "(" SPDLOG_STR_HELPER(__LINE__) ") ] " __VA_ARGS__)
#  else
#    define SPDLOG_TRACE(logger, ...) logger->trace("[ " __FILE__ ":" SPDLOG_STR_HELPER(__LINE__) " ] " __VA_ARGS__)
#  endif
#else
#  define SPDLOG_TRACE(logger, ...) (void)0
#endif

#ifdef SPDLOG_DEBUG_ON
#  define SPDLOG_DEBUG(logger, ...) logger->debug(__VA_ARGS__)
#else
#  define SPDLOG_DEBUG(logger, ...) (void)0
#endif

4、同步和異步設置 Asynchronous logging

官方說明:https://github.com/gabime/spdlog/wiki/6.-Asynchronous-logging

默認情況下是不開啟異步模式的,開啟異步模式方式如下:

size_t q_size = 4096; //queue size must be power of 2
    spdlog::set_async_mode(q_size);

隊列大小:

隊列占用的內存 = 設置的隊列大小 * slot的大小, 64位系統下slot大小為104字節。由此可根據系統的log輸出總量來確定隊列大小。

技術分享圖片

隊列機制:

異步模式下,所有輸出的日誌將先存入隊列,再由工作者線程從隊列中取出日誌並輸出。當隊列存滿時,需要根據設置好的隊列存滿策略來處置新來的日誌(阻塞消息或者丟棄消息)。如果工作者線程中拋出了異常,向隊列寫入下一條日誌時異常會再次拋出,可以在寫入隊列時捕捉工作者線程的異常。

技術分享圖片

隊列存滿時(Full queue policy)兩種應對方式:

(1)阻塞新來的日誌,直到隊列中有剩余空間。這是默認的處理方式。

(2)丟棄新來的日誌。如下:

spdlog::set_async_mode(q_size, spdlog::async_overflow_policy::discard_log_msg)

兩種應對方式如下:

// Async overflow policy - block by default.
//
enum class async_overflow_policy
{
    block_retry, // Block / yield / sleep until message can be enqueued
    discard_log_msg // Discard the message it enqueue fails
};

5、處理spdlog的異常 set_error_handler

官方說明:https://github.com/gabime/spdlog/wiki/Error-handling

當輸出日誌時發生異常時,spdlog會向std::err 打印一條語句,為了避免輸出的異常語句刷屏,打印頻率被限制在每分鐘一條。

下面函數執行時,由於最後一條輸出log的語句中四個參數只給了一個,所以spdlog調用了異常處理函數,輸出異常。

void err_handler_example()
{
    //can be set globaly or per logger(logger->set_error_handler(..))
    spdlog::set_error_handler([](const std::string& msg)
    {
        std::cerr << "my err handler: " << msg << std::endl;
    });
    spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3);
}

技術分享圖片

6、apply_all 使所有的logger同時輸出

所有註冊過的logger都會輸出End of example 這句話,代表程序結束。

// Apply a function on all registered loggers
        spd::apply_all([&](std::shared_ptr<spdlog::logger> l)
        {
            l->info("End of example.");
        });

7、drop -- 釋放logger

在程序結束時,應該調用drop_all() 釋放所有logger。

There is a bug in VS runtime that cause the application dead lock when it exits. If you use async logging, please make sure to call spdlog::drop_all() before main() exit. If some loggers are not in the registry, those should be released manually as well. stackoverflow: std::thread join hangs if called after main exits when using vs2012 rc

// Release and close all loggers
        spdlog::drop_all();

或者單獨drop某個logger

spd::drop("console");
        spd::drop("basic_logger");

c++ 日誌輸出庫 spdlog 簡介(2)