日志的艺术：深入理解 spdlog

目录

1. 为什么需要日志？

2. 同步日志 vs. 异步日志

3. spdlog 的核心组成部分

4. 如何创建一个Logger

5. 如何选择输出目标（Sink）

6. 个性化你的日志格式

7. 异步日志的魔法

8. 刷新策略：何时将日志写入

9. 调整线程池：根据需要定制

10. 完整的异步日志示例

总结

---

1. 为什么需要日志？

想象一下，你在烹饪一顿大餐，每一步都详细记录下来。这样，即使哪道菜出了问题，你也能迅速找到问题所在。日志在编程中的作用就像是厨房里的菜谱，帮助你：

• 追踪程序的每一步：了解程序在干什么，执行到哪一步。
• 定位问题：当程序出错时，日志会告诉你哪里出了问题。
• 优化性能：通过日志分析，发现程序的瓶颈，进行优化。

2. 同步日志 vs. 异步日志

在spdlog中，你可以选择两种方式来记录日志，就像选择不同的烹饪方法：

• 同步日志：就像你一边炒菜一边看菜谱，每次记录日志都会立即写入。这种方式简单可靠，但在高频率记录时可能会稍微影响程序的性能。

  spdlog::info("这是一个同步日志");
  

• 异步日志：好比你把菜谱放在一边，专心炒菜，等一会儿再统一查看。这种方式不会阻塞你的主程序，性能更高，但需要一些额外的配置来确保日志的安全性和顺序性。

  #include <spdlog/spdlog.h>
  #include <spdlog/async.h>
  #include <spdlog/sinks/basic_file_sink.h>
  
  int main() {
      // 初始化一个日志线程池
      spdlog::init_thread_pool(8192, 1);
      auto async_logger = spdlog::basic_logger_mt<spdlog::async_factory>("async_logger", "logs/async_log.txt");
      
      async_logger->info("这是一个异步日志");
      async_logger->flush(); // 确保日志写入
      return 0;
  }
  

3. spdlog 的核心组成部分

让我们来看看spdlog是由哪些“食材”组成的：

1. Registry（注册表）：

   • 作用：就像厨房的调料架，管理所有的Logger（日志记录器），确保每个模块都能使用同一个Logger。
   • 使用方法：通过spdlog::register_logger()将Logger注册进去，方便随时调用。

2. Logger 和 Async Logger：

   • Logger：负责接收日志消息并将其分发到不同的“容器”（Sink）中。同步Logger会立即处理日志。
   • Async Logger（异步 Logger）：将日志消息放入队列，由后台线程异步处理，提高性能。

3. Thread Pool（线程池）：

   • 作用：在异步日志中，线程池就像厨房里的助理，负责处理日志消息的写入工作。
   • 使用方法：通过spdlog::init_thread_pool()来初始化，设置队列大小和线程数量。

4. Sink 和 Formatter：

   • Sink（输出目标）：日志最终的存放地，可以是文件、控制台，甚至是自定义的地方。
   • Formatter（格式化器）：负责将日志消息整理成指定的格式，比如加上时间戳、日志级别等信息。

4. 如何创建一个Logger

创建Logger就像选择烹饪的锅具，根据需要选择不同的“锅”来记录日志：

• 手动创建：

  #include <spdlog/spdlog.h>
  #include <spdlog/sinks/stdout_color_sinks.h>
  
  int main() {
      auto console_logger = spdlog::stdout_color_mt("console");
      console_logger->info("手动创建的 logger");
      return 0;
  }
  

• 注册 Logger：

  #include <spdlog/spdlog.h>
  #include <spdlog/sinks/basic_file_sink.h>
  
  int main() {
      auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("logs/logfile.txt", true);
      auto file_logger = std::make_shared<spdlog::logger>("file_logger", file_sink);
      spdlog::register_logger(file_logger);
      file_logger->info("注册的 logger 写入文件");
      return 0;
  }
  

5. 如何选择输出目标（Sink）

选择日志的“存放地”就像决定你的菜是放在盘子里还是碗里。spdlog提供了多种内置的Sink，也支持你自己动手创建：

• 内置 Sink：

  auto file_sink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("logs/logfile.txt", true);
  auto file_logger = stddlog::logger>("file_logger", file_sink);
  file_logger->info("日志写入文件 Sink");
  

• 自定义 Sink：

  #include <spdlog/spdlog.h>
  #include <spdlog/sinks/sink.h>
  #include <iostream>
  
  class my_sink : public spdlog::sinks::sink {
  public:
      void log(const spdlog::details::log_msg& msg) override {
          std::cout << "自定义 Sink: " << msg.payload << std::endl;
      }
  
      void flush() override {}
  };
  
  int main() {
      auto custom_sink = std::make_shared<my_sink>();
      auto custom_logger = std::make_shared<spdlog::logger>("custom_logger", custom_sink);
      spdlog::register_logger(custom_logger);
      custom_logger->info("这是一个自定义的 Sink");
      return 0;
  }
  

6. 个性化你的日志格式

想让你的日志更有个性，就像为你的菜品加上独特的装饰。spdlog允许你自定义日志的格式：

#include <spdlog/spdlog.h>

int main() {
    auto logger = spdlog::stdout_color_mt("console");
    // 设置日志格式：时间、日志级别、线程 ID、日志消息
    logger->set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%l] [%t] %v");
    logger->info("这是一条格式化的日志");
    return 0;
}

常用的格式化标识包括：

• %Y-%m-%d %H:%M:%S：日期和时间
• %l：日志级别
• %t：线程 ID
• %v：日志消息

7. 异步日志的魔法

如果你的程序需要频繁记录日志，异步日志就像是一个高效的助理，帮你处理繁重的日志任务：

#include <spdlog/spdlog.h>
#include <spdlog/async.h>
#include <spdlog/sinks/basic_file_sink.h>

int main() {
    // 初始化线程池，队列大小为8192，线程数为1
    spdlog::init_thread_pool(8192, 1);

    // 创建一个异步文件日志器
    auto async_logger = spdlog::basic_logger_mt<spdlog::async_factory>("async_logger", "logs/async_log.txt");

    // 记录异步日志
    async_logger->info("这是一条异步日志消息");

    // 强制刷新日志到文件
    async_logger->flush();

    return 0;
}

8. 刷新策略：何时将日志写入

就像决定什么时候把食物从锅里盛出来，刷新策略决定了何时将日志写入到目标位置：

• 手动刷新：

  logger->flush();
  

• 条件刷新（比如遇到错误级别的日志时刷新）：

  logger->flush_on(spdlog::level::err);
  

• 定时刷新（每隔一段时间自动刷新）：

  spdlog::flush_every(std::chrono::seconds(5)); // 每5秒刷新一次日志
  

9. 调整线程池：根据需要定制

如果你需要处理更多的日志，就像需要更多的厨具和助手一样，可以调整线程池的大小和溢出策略：

• 调整队列大小和线程数量：

  spdlog::init_thread_pool(16384, 2); // 队列大小为16384，线程数为2
  

• 设置溢出策略（当日志队列满了怎么办）：

  • 阻塞：等待有空余位置。
  • 丢弃最旧的日志：保留最新的日志。

  auto async_logger = spdlog::basic_logger_mt<spdlog::async_factory>("async_file_logger", "logs/async_file.txt");
  async_logger->set_overflow_policy(spdlog::async_overflow_policy::overrun_oldest);
  

10. 完整的异步日志示例

让我们来看一个完整的例子，看看如何一步步搭建一个高效的异步日志系统：

#include <spdlog/spdlog.h>
#include <spdlog/async.h>
#include <spdlog/sinks/basic_file_sink.h>

int main() {
    // 1. 初始化线程池，队列大小为8192，线程数为1
    spdlog::init_thread_pool(8192, 1);

    // 2. 创建一个异步文件日志器
    auto async_logger = spdlog::basic_logger_mt<spdlog::async_factory>("async_logger", "logs/async_log.txt");

    // 3. 设置日志格式
    async_logger->set_pattern("[%Y-%m-%d %H:%M:%S.%e] [%l] [%t] %v");

    // 4. 记录日志
    async_logger->info("这是一条异步日志消息");

    // 5. 强制刷新日志到文件
    async_logger->flush();

    return 0;
}

总结

spdlog就像是你编程中的一位得力助手，帮你高效、灵活地记录和管理日志。无论是简单的控制台输出，还是复杂的异步文件记录，spdlog都能轻松应对。通过合理配置，你可以让日志系统既高效又易用，为你的项目保驾护航。

参考

0voice · GitHubhttps://github.com/0voice