參考檔案：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/#pattern-flags

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/#implementing-your-own-sink

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");
}

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/514989.html

標籤：C++

上一篇：C++ Null 指標的使用

下一篇：MybatisPlus生成主鍵策略方法

【C++】spdlog光速入門，C++logger最簡單最快的庫