參考檔案：https://spdlog.docsforge.com/master/

spdlog簡介

Very fast, header only, C++ logging library.
一個header-only的C++紀錄檔庫，十分高效且易用。

獲取安裝方式

https://github.com/gabime/spdlog
使用時只需要將git專案內的/include/spdlog資料夾整個放入專案的include目錄下即可

使用樣例

#include "spdlog/spdlog.h"

int main() 
{
    spdlog::info("Welcome to spdlog!");
    spdlog::error("Some error message with arg: {}", 1);
    
    spdlog::warn("Easy padding in numbers like {:08d}", 12);
    spdlog::critical("Support for int: {0:d};  hex: {0:x};  oct: {0:o}; bin: {0:b}", 42);
    spdlog::info("Support for floats {:03.2f}", 1.23456);
    spdlog::info("Positional args are {1} {0}..", "too", "supported");
    spdlog::info("{:<30}", "left aligned");
    
    spdlog::set_level(spdlog::level::debug); // Set global log level to debug
    spdlog::debug("This message should be displayed..");    
    
    // change log pattern
    spdlog::set_pattern("[%H:%M:%S %z] [%n] [%^---%L---%$] [thread %t] %v");
    
    // Compile time log levels
    // define SPDLOG_ACTIVE_LEVEL to desired level
    SPDLOG_TRACE("Some trace message with param {}", 42);
    SPDLOG_DEBUG("Some debug message");
}

快速入門

幾個核心概念

• logger：紀錄檔物件，每個紀錄檔內包含一個sink組成的vector，每個sink可以分別設定優先順序，logger本身也可設定優先順序
• sink：直譯是水槽，實際上是引流的物件或者可以認為是輸出目標，spdlog庫內建了多種不同型別的logger可供選擇
• formatter：格式化物件，絕大部分情況下spdlog預設的格式就足夠用了，但是如果有個性化需求，可以進行自定義格式
• level：紀錄檔級別，不同的紀錄檔庫可能會有不同的設定，但是基本情況下都會有debug、info、warn、error等的級別劃分來處理不同的情況，具體各個級別的情況可以根據自己的實際情況選取

邏輯關係：每個logger包含一個vector，該vector由一個或多個std::shared_ptr<sink>組成，logger的每條紀錄檔都會呼叫sink物件，由sink物件按照formatter的格式輸出到sink指定的地方（有可能是控制檯、檔案等），接下來我們從內到外的講解spdlog的這三個核心元件

formatter

formatter也即格式化物件，用於控制紀錄檔的輸出格式,spdlog自帶了預設的formatter，一般情況下，我們無需任何修改，直接使用即可。注意，每個sink會有一個formatter

預設formatter

預設formatter的格式為：[日期時間] [logger名] [log級別] log內容

[2022-10-13 17:00:55.795] [sidecar] [debug] found env KAFKA_PARTITION_VALUE : -1
[2022-10-13 17:00:55.795] [sidecar_config] [debug] kafka_config.kafka_brokers : localhost:9092
[2022-10-13 17:00:55.795] [sidecar_config] [debug] kafka_config.kafka_main_topic : workflow_queue
[2022-10-13 17:00:55.795] [sidecar_config] [debug] kafka_config.kafka_partition_value : -1
[2022-10-13 17:00:55.795] [sidecar] [info] SidecarConfig initialized

自定義formatter

如果預設的formatter不符合需求，可以自定義formatter，具體方式如下

• set_parrtern(pattern_string);
  • 例如：
  • 全域性級別的：spdlog::set_pattern(" [%H:%M:%S %z] [thread %t] %v ");
  • 單個logger級別的：some_logger->set_parttern(">>> %H:%M:%S %z %v <<<");
  • 單個sink級別的：some_sink-> set_parttern(".. %H: %M ..");
    其中用到了%H %M這些預留位置，事實上它們都是預先設定好的，想要檢視所有的預留位置情況，可以參考以下網站：
    https://spdlog.docsforge.com/v1.x/3.custom-formatting/

sink

每個sink對應著一個輸出目標和輸出格式，它內部包含一個formatter，輸出目標可以是控制檯、檔案等地方。
所有的sink都在名稱空間spdlog::sinks下，可以自行探索

控制檯sink

spdlog中建立控制檯sink非常簡單，該方式建立的sink會輸出到命令列終端，且是彩色的（也可以選非彩色的，但是有彩色的應該都會選彩色的吧……）。字尾的_mt代表多執行緒，_st代表單執行緒

auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();

檔案sink

檔案sink的型別有很多，這裡展示幾種經典型別

auto sink1 = std::make_shared<spdlog::sinks::basic_file_sink_mt>(log_file_name);//最簡單的檔案sink，只需要指定檔名

auto sink2 = std::make_shared<spdlog::sinks::daily_file_sink_mt>(log_file_name, path, 14, 22);//每天的14點22分在path下建立新的檔案

auto sink3 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>(log_file_name, 1024 * 1024 * 10, 100, false);//輪轉檔案，一個檔案滿了會寫到下一個檔案，第二個引數是單檔案大小上限，第三個引數是檔案數量最大值

其他sink

ostream_sink
syslog_sink
......
也可以通過繼承base_sink建立子類來自定義sink，具體可以參考：
https://spdlog.docsforge.com/v1.x/4.sinks/

sink的flush問題

建立好sink後建議設定flush方式，否則可能無法立刻在file中看到logger的內容
以下為兩種重要的flush方式設定（直接設定全域性）

spdlog::flush_every(std::chrono::seconds(1));
spdlog::flush_on(spdlog::level::debug);

logger

紀錄檔物件，每個logger內包含了一個vector用於存放sink，每個sink都是相互獨立
因此一個紀錄檔物件在輸出紀錄檔時可以同時輸出到控制檯和檔案等位置

使用預設logger

如果整個專案中只需要一個logger，spdlog提供了最為便捷的預設logger，注意，該logger在全域性公用，輸出到控制檯、多執行緒、彩色

//Use the default logger (stdout, multi-threaded, colored)
spdlog::info("Hello, {}!", "World");

建立特定的logger

大部分情況下預設logger是不夠用的，因為我們可能需要做不同專案模組各自的logger，可能需要logger輸出到檔案進行持久化，所以建立logger是很重要的一件事。好在建立logger也是非常簡單的！

方式一：直接建立

與建立sink類似，我們可以非常便捷的建立logger
由於大部分時候一個logger只會有一個sink，所以spdlog提供了建立logger的介面並封裝了建立sink的過程

auto console = spdlog::stdout_color_mt("some_unique_name");//一個輸出到控制檯的彩色多執行緒logger，可以指定名字
auto file_logger = spdlog::rotating_logger_mt("file_logger", "logs/mylogfile", 1048576 * 5, 3);//一個輸出到指定檔案的輪轉檔案logger，後面的引數指定了檔案的資訊

方式二：組合sinks方式建立

有時候，單sink的logger不夠用，那麼可以先建立sink的vector，然後使用sinks_vector建立logger
以下樣例中，首先建立了sink的vector，然後建立了兩個sink並放入vector，最後使用該vector建立了logger，其中，set_level的過程不是必須的，register_logger一般是必須的，否則只能在建立logger的地方使用該logger，關於register的問題可以往下看

    std::vector<spdlog::sink_ptr> sinks;

    auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
    sink1->set_level(SidecarLoggers::getGlobalLevel());
    sinks.push_back(sink1);

    auto sink2 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>(log_file_name, 1024 * 1024 * 10, 100, false);
    sink2->set_level(spdlog::level::debug);
    sinks.push_back(sink2);
    
    auto logger = std::make_shared<spdlog::logger>("logger_name", begin(sinks), end(sinks));
    logger->set_level(spdlog::level::debug);
    spdlog::register_logger(logger);

logger的註冊與獲取

在一個地方建立了logger卻只能在該處使用肯定是不好用的，所以spdlog提供了一個全域性註冊和獲取logger，我們只需要在某處先建立logger並註冊，那麼後面在其他地方使用時直接獲取就可以了
註冊：spdlog::register_logger()
獲取：spdlog::get()

//上面的程式碼中我們註冊了一個logger，名字是logger_name，接下來嘗試獲取
auto logger = SidecarLoggers::getLogger("logger_name");

關於註冊與獲取需要注意的事

• 必須先建立註冊才能獲取，建議每個模組的logger都在整個模組最開始初始化時建立並註冊。如果在全域性嘗試獲取不存在的logger，會返回空指標，如果恰好又使用空指標嘗試輸出logger,會造成整個程式的崩潰（存取非法記憶體了，segment fault）
• 通過上述的方式一建立的logger是自動註冊的，不需要手動註冊，但是方式二建立的logger需要手動註冊
• 一旦註冊，全域性使用，名字標識logger，在各個模組獲取同一個名字的logger會獲取到同一個logger的指標

logger的使用

獲取到一個logger之後，就可以愉快的使用它了，使用起來很簡單

logger->debug("this is a debug msg");
logger->warn("warn!!!!");
logger->info("hello world");
logger->error("燙燙燙燙");

logger的level設定

logger的預設level是info，如果處於開發環境或者生產環境，會只需要debug級別以上或者warn級別以上的log
要設定logger的級別，很簡單：

logger->set_level(spdlog::level::debug);

可以設定全域性logger級別

spdlog::set_level(spdlog::level::warn);

可以設定sink級別的logger

sink1->set_level(spdlog::level::info);

注意：一個logger內假如有多個sink，那麼這些sink分別設定level是可以不同的，但是由於logger本身也有level，所以真正使用時，logger的level如果高於某個sink，會覆蓋該sink的level，所以建議此時把logger的level手動設定為debug（預設為info）

樣例程式碼

以下程式碼為本人對spdlog的簡單使用封裝，主要功能有：

• 一鍵初始化，根據環境變數可設定修改logger級別等
• 一鍵建立雙sink的logger（控制檯和檔案）
• 一鍵獲取logger，假如logger不存在則建立

標頭檔案

#ifndef SIDECAR_LOGGER_H
#define SIDECAR_LOGGER_H

#include <stdlib.h>
#include "spdlog/spdlog.h"
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/stdout_sinks.h"
#include "spdlog/sinks/basic_file_sink.h"
#include "spdlog/sinks/rotating_file_sink.h"
#include "spdlog/sinks/daily_file_sink.h"
#include <vector>

class SidecarLoggers
{
public:
    static void init();
    static spdlog::level::level_enum getGlobalLevel();
    static std::vector<spdlog::sink_ptr> createSinks(const std::string &log_file_name);
    static void createLogger(const std::string &logger_name);
    static std::shared_ptr<spdlog::logger> getLogger(const std::string &logger_name);

private:
    static spdlog::level::level_enum global_level;
};

#endif

原始檔

#include "sidecar_logger.h"

spdlog::level::level_enum SidecarLoggers::global_level = spdlog::level::info;

spdlog::level::level_enum SidecarLoggers::getGlobalLevel()
{
    return global_level;
}

std::vector<spdlog::sink_ptr> SidecarLoggers::createSinks(const std::string &log_file_name)
{
    std::vector<spdlog::sink_ptr> sinks;

    auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
    sink1->set_level(SidecarLoggers::getGlobalLevel());
    sinks.push_back(sink1);

    auto sink2 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>(log_file_name, 1024 * 1024 * 10, 100, false);
    sink2->set_level(spdlog::level::debug);
    sinks.push_back(sink2);
    return sinks;
}

void SidecarLoggers::createLogger(const std::string &logger_name)
{
    std::string log_file_name = logger_name + "_log.txt";
    auto sinks = SidecarLoggers::createSinks(log_file_name);

    auto logger = std::make_shared<spdlog::logger>(logger_name, begin(sinks), end(sinks));
    logger->set_level(spdlog::level::debug);
    spdlog::register_logger(logger);
}

std::shared_ptr<spdlog::logger> SidecarLoggers::getLogger(const std::string &logger_name){
    auto logger = spdlog::get(logger_name);
    if(!logger){//looger指向為空
        createLogger(logger_name);
        logger = spdlog::get(logger_name);
    }
    return logger;
}


void SidecarLoggers::init()
{
    auto level = spdlog::level::debug;
    if (std::getenv("STAGE") != NULL)
    {
        std::string stage = std::getenv("STAGE");
        if (stage == "dev")
            level = spdlog::level::debug;
    }
    SidecarLoggers::global_level = level;

    spdlog::flush_every(std::chrono::seconds(1));
    spdlog::flush_on(spdlog::level::debug);

    SidecarLoggers::createLogger("sidecar");
}