spdlog 入门

2021/1/20 toolslog

快速,仅头文件或/编译的 C++ 日志库。

# 安装

# 仅头文件版本

将源文件夹 (opens new window) 复制到构建树并使用 C++11 编译器。

# 静态库版本(推荐-更快的编译时间)

$ git clone https://github.com/gabime/spdlog.git
$ cd spdlog && mkdir build && cd build
$ cmake .. && make -j
1
2
3

使用方法请参见示例 CMakeLists.txt (opens new window)

# 平台

  • Linux, FreeBSD, OpenBSD, Solaris, AIX
  • Windows (msvc 2013+, cygwin)
  • macOS (clang 3.5+)
  • Android

# 包管理器:

  • Homebrew: brew install spdlog
  • MacPorts: sudo port install spdlog
  • FreeBSD: cd /usr/ports/devel/spdlog/ && make install clean
  • Fedora: dnf install spdlog
  • Gentoo: emerge dev-libs/spdlog
  • Arch Linux: pacman -S spdlog
  • vcpkg: vcpkg install spdlog
  • conan: spdlog/[>=1.4.1]
  • conda: conda install -c conda-forge spdlog

# 特征

  • 非常快(请参见下面的benchmarks)。
  • 仅头文件或编译
  • 得益于出色的 fmt (opens new window) 库,具有丰富功能的格式设置。
  • 异步模式(可选)
  • 自定义 (opens new window) 格式.
  • 多/单线程日志器。
  • 各种日志目标:
    • 循环日志文件
    • 每日日志文件
    • 控制台日志记录(支持颜色输出)
    • 系统日志
    • Windows调试器(OutputDebugString(..))
    • 使用自定义日志对象可以实现轻松扩展(只需在 sink接口中实现单个功能)
  • 日志过滤-日志级别可以在运行时以及编译时进行修改。
  • 支持从 argv 或环境 var 加载日志级别。
  • 回溯 支持 - 将调试消息存储在环形缓冲区中,并在以后按需显示。

# 使用示例

# 基本用法

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 创建 stdout/stderr 对象

#include "spdlog/spdlog.h"
#include "spdlog/sinks/stdout_color_sinks.h"
void stdout_example()
{
    // 创建彩色多线程记录器
    auto console = spdlog::stdout_color_mt("console");    
    auto err_logger = spdlog::stderr_color_mt("stderr");    
    spdlog::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name)");
}
1
2
3
4
5
6
7
8
9

# 基本文件记录器

#include "spdlog/sinks/basic_file_sink.h"
void basic_logfile_example()
{
    try 
    {
        auto logger = spdlog::basic_logger_mt("basic_logger", "logs/basic-log.txt");
    }
    catch (const spdlog::spdlog_ex &ex)
    {
        std::cout << "Log init failed: " << ex.what() << std::endl;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

# 循环日志文件

#include "spdlog/sinks/rotating_file_sink.h"
void rotating_example()
{
    // 创建最大 5mb 大小和 3 个循环文件的循环日志器
    auto max_size = 1048576 * 5;
    auto max_files = 3;
    auto logger = spdlog::rotating_logger_mt("some_logger_name", "logs/rotating.txt", max_size, max_files);
}
1
2
3
4
5
6
7
8

# 每日文件


#include "spdlog/sinks/daily_file_sink.h"
void daily_example()
{
    // 创建每日日志器 - 每天凌晨 2:30 创建一个新文件
    auto logger = spdlog::daily_logger_mt("daily_logger", "logs/daily.txt", 2, 30);
}

1
2
3
4
5
6
7
8

# 回溯支持

// 记录器可以将所有消息(包括调试/跟踪)存储在环形缓冲区中,并在以后按需显示。
// 需要时,调用 dump_backtrace() 来查看它们

spdlog::enable_backtrace(32); // 将最新的 32 条消息存储在缓冲区中。较旧的消息将被丢弃。
// 或 my_logger->enable_backtrace(32)。
for(int i = 0; i < 100; i++)
{
  spdlog::debug("Backtrace message {}", i); // 尚未记录
}
// e.g. 如果发生错误:
spdlog::dump_backtrace(); // 立即记录!显示最近的32条消息

// 或 my_logger->dump_backtrace(32)..
1
2
3
4
5
6
7
8
9
10
11
12
13

# 定期刷新

// 每 3 秒定期刷新所有 *已注册* 记录器:
// 警告:仅当所有记录器都是线程安全的时才使用("_mt" 记录器)
spdlog::flush_every(std::chrono::seconds(3));

1
2
3
4

# Stopwatch

// spdlog 对 Stopwatch 的支持
#include "spdlog/stopwatch.h"
void stopwatch_example()
{
    spdlog::stopwatch sw;    
    spdlog::debug("Elapsed {}", sw);
    spdlog::debug("Elapsed {:.3}", sw);       
}
1
2
3
4
5
6
7
8

# 用十六进制记录二进制数据

// 可以使用许多类型的 std::container<char> 类型。
// 范围也受支持。
// 格式标志:
// {:X} - 大写打印。
// {:s} - 不要用空格分隔每个字节。
// {:p} - 不要在每一行的开始处打印位置。
// {:n} - 不要将输出分成几行。
// {:a} - 如果未设置 :n,则显示 ASCII。

#include "spdlog/fmt/bin_to_hex.h"

void binary_example()
{
    auto console = spdlog::get("console");
    std::array<char, 80> buf;
    console->info("Binary example: {}", spdlog::to_hex(buf));
    console->info("Another binary example:{:n}", spdlog::to_hex(std::begin(buf), std::begin(buf) + 10));
    // 更多例子:
    // logger->info("uppercase: {:X}", spdlog::to_hex(buf));
    // logger->info("uppercase, no delimiters: {:Xs}", spdlog::to_hex(buf));
    // logger->info("uppercase, no delimiters, no position info: {:Xsp}", spdlog::to_hex(buf));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 带有多个接收器的记录器 - 每个接收器具有不同的格式和日志级别


// 创建具有 2 个目标的记录器,这些目标具有不同的日志级别和格式。
// 控制台将仅显示警告或错误,而文件将全部记录。
void multi_sink_example()
{
    auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
    console_sink->set_level(spdlog::level::warn);
    console_sink->set_pattern("[multi_sink_example] [%^%l%$] %v");

    auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("logs/multisink.txt", true);
    file_sink->set_level(spdlog::level::trace);

    spdlog::logger logger("multi_sink", {console_sink, file_sink});
    logger.set_level(spdlog::level::debug);
    logger.warn("this should appear in both console and file");
    logger.info("this message should not appear in the console, only in the file");
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 异步记录

#include "spdlog/async.h"
#include "spdlog/sinks/basic_file_sink.h"
void async_example()
{
    // 默认线程池设置可以在创建异步记录器之前进行修改:
    // spdlog::init_thread_pool(8192, 1); // queue with 8k items and 1 backing thread.
    auto async_file = spdlog::basic_logger_mt<spdlog::async_factory>("async_file_logger", "logs/async_log.txt");
    // 或者:
    // auto async_file = spdlog::create_async<spdlog::sinks::basic_file_sink_mt>("async_file_logger", "logs/async_log.txt");
}
1
2
3
4
5
6
7
8
9
10

# 带有多个接收器的异步记录器

#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/rotating_file_sink.h"

void multi_sink_example2()
{
    spdlog::init_thread_pool(8192, 1);
    auto stdout_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt >();
    auto rotating_sink = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("mylog.txt", 1024*1024*10, 3);
    std::vector<spdlog::sink_ptr> sinks {stdout_sink, rotating_sink};
    auto logger = std::make_shared<spdlog::async_logger>("loggername", sinks.begin(), sinks.end(), spdlog::thread_pool(), spdlog::async_overflow_policy::block);
    spdlog::register_logger(logger);
}
1
2
3
4
5
6
7
8
9
10
11
12

# 自定义类型

// 通过实现 operator<< 记录自定义类型
#include "spdlog/fmt/ostr.h" // 必须包括
struct my_type
{
    int i;
    template<typename OStream>
    friend OStream &operator<<(OStream &os, const my_type &c)
    {
        return os << "[my_type i=" << c.i << "]";
    }
};

void user_defined_example()
{
    spdlog::get("console")->info("user defined type: {}", my_type{14});
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 日志模式中的自定义标志

// 日志模式可以包含自定义标志。
// 以下示例将添加新标志 '%*' - 将其绑定到 <my_formatter_flag> 实例。
#include "spdlog/pattern_formatter.h"
class my_formatter_flag : public spdlog::custom_flag_formatter
{
public:
    void format(const spdlog::details::log_msg &, const std::tm &, spdlog::memory_buf_t &dest) override
    {
        std::string some_txt = "custom-flag";
        dest.append(some_txt.data(), some_txt.data() + some_txt.size());
    }

    std::unique_ptr<custom_flag_formatter> clone() const override
    {
        return spdlog::details::make_unique<my_formatter_flag>();
    }
};

void custom_flags_example()
{    
    auto formatter = std::make_unique<spdlog::pattern_formatter>();
    formatter->add_flag<my_formatter_flag>('*').set_pattern("[%n] [%*] [%^%l%$] %v");
    spdlog::set_formatter(std::move(formatter));
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 自定义错误处理

void err_handler_example()
{
    // 可以全局设置或为每个记录器设置(logger->set_error_handler(..))
    spdlog::set_error_handler([](const std::string &msg) { spdlog::get("console")->error("*** LOGGER ERROR ***: {}", msg); });
    spdlog::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3);
}

1
2
3
4
5
6
7

# 系统日志

#include "spdlog/sinks/syslog_sink.h"
void syslog_example()
{
    std::string ident = "spdlog-example";
    auto syslog_logger = spdlog::syslog_logger_mt("syslog", ident, LOG_PID);
    syslog_logger->warn("This is warning that will end up in syslog.");
}
1
2
3
4
5
6
7

# Android 示例

#include "spdlog/sinks/android_sink.h"
void android_example()
{
    std::string tag = "spdlog-android";
    auto android_logger = spdlog::android_logger_mt("android", tag);
    android_logger->critical("Use \"adb shell logcat\" to view this message.");
}
1
2
3
4
5
6
7

# 从环境变量或 argv 加载日志级别

#include "spdlog/cfg/env.h"
int main (int argc, char *argv[])
{
    spdlog::cfg::load_env_levels();
    // or from command line:
    // ./example SPDLOG_LEVEL=info,mylogger=trace
    // #include "spdlog/cfg/argv.h" // for loading levels from argv
    // spdlog::cfg::load_argv_levels(argc, argv);
}
1
2
3
4
5
6
7
8
9

因此,可以:

$ export SPDLOG_LEVEL=info,mylogger=trace
$ ./example
1
2

# 基准测试

以下是在 Ubuntu 64位,Intel i7-4770 CPU @ 3.40GHz 下完成的一些 基准测试 (opens new window)

# 同步模式

[info] **************************************************************
[info] Single thread, 1,000,000 iterations
[info] **************************************************************
[info] basic_st         Elapsed: 0.17 secs        5,777,626/sec
[info] rotating_st      Elapsed: 0.18 secs        5,475,894/sec
[info] daily_st         Elapsed: 0.20 secs        5,062,659/sec
[info] empty_logger     Elapsed: 0.07 secs       14,127,300/sec
[info] **************************************************************
[info] C-string (400 bytes). Single thread, 1,000,000 iterations
[info] **************************************************************
[info] basic_st         Elapsed: 0.41 secs        2,412,483/sec
[info] rotating_st      Elapsed: 0.72 secs        1,389,196/sec
[info] daily_st         Elapsed: 0.42 secs        2,393,298/sec
[info] null_st          Elapsed: 0.04 secs       27,446,957/sec
[info] **************************************************************
[info] 10 threads, competing over the same logger object, 1,000,000 iterations
[info] **************************************************************
[info] basic_mt         Elapsed: 0.60 secs        1,659,613/sec
[info] rotating_mt      Elapsed: 0.62 secs        1,612,493/sec
[info] daily_mt         Elapsed: 0.61 secs        1,638,305/sec
[info] null_mt          Elapsed: 0.16 secs        6,272,758/sec
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 异步模式

[info] -------------------------------------------------
[info] Messages     : 1,000,000
[info] Threads      : 10
[info] Queue        : 8,192 slots
[info] Queue memory : 8,192 x 272 = 2,176 KB 
[info] -------------------------------------------------
[info] 
[info] *********************************
[info] Queue Overflow Policy: block
[info] *********************************
[info] Elapsed: 1.70784 secs     585,535/sec
[info] Elapsed: 1.69805 secs     588,910/sec
[info] Elapsed: 1.7026 secs      587,337/sec
[info] 
[info] *********************************
[info] Queue Overflow Policy: overrun
[info] *********************************
[info] Elapsed: 0.372816 secs    2,682,285/sec
[info] Elapsed: 0.379758 secs    2,633,255/sec
[info] Elapsed: 0.373532 secs    2,677,147/sec

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 文献资料

可以在 wiki (opens new window) 页面中找到文档。

Last Updated: 2023-10-29T08:26:04.000Z