简单好用的C++日志库spdlog使用示例

news2025/1/19 3:40:29

文章目录

  • 前言
  • 一、spdlog的日志风格
    • fmt风格
    • printf风格
  • 二、日志格式pattern
  • 三、sink，多端写入
  • 四、异步写入
  • 五、注意事项
  • 六、自己封装了的代码
    • usespdlog.h
    • 封装代码解释
    • 使用示例

前言

C++日志库有很多，glog，log4cpp，easylogging++, easylogger, plog,spdlog等等。每个都大致了解过，看过github代码，看下来还是觉得spdlog用起来最方便最简单，head-only。别看easylogging++只有2个文件，但是可读性有点差, plog虽然也比较简单，但是没有异步写日志。
spdlog地址：https://github.com/gabime/spdlog

一、spdlog的日志风格

fmt风格

与printf风格不同，spdlog采用的是fmt格式，也就是类似于：

fmt::print("我是{} 我有{}万",小明，1000)

fmt风格比较安全，多一个参数少一个参数都会抛异常，printf是可能会直接内存错误的。

printf风格

虽然spdlog本身只支持fmt风格，但是我们可以自己按printf风格解析然后按无参的形式写入spdlog。

二、日志格式pattern

通过pattern我们可以控制日志的格式，例如以下是一个常用格式：

%^[%Y-%m-%d %H:%M:%S.%e] [%-8l] [%s:%#] %v%$
[2024-06-18 16:27:08.778] [warning ] [Config.cpp:50] 这是一条日志消息

pattern支持日期时间、日志等级显示、代码行数、控制台颜色等常用格式，详细的可以看它github介绍，挺清晰的。上面这个pattern就是时间精确到毫秒，日志等级字段占8个字符左对齐，显示源文件和代码行数，在控制台中按照日志等级显示颜色。
在这里插入图片描述

三、sink，多端写入

sink在其它库里面可能叫appender，就是日志怎么写入终端，写到哪个终端。比如一条日志消息可以同时写入控制台、文件、tcp等等。一般常用的就是写到控制台和文件，文件按日期保存或者按log1.txt，log2.txt切割。

四、异步写入

spdlog中有普通的logger和async_logger，使用异步logger时需要事先初始化一个线程池。

五、注意事项

  1. 普通的logger就是阻塞主线程的，可以使用async_logger异步写日志。
  2. 如果想要打印出源码文件名和序号，必须是用宏才可以，spdlog自带的宏是SPDLOG
  3. 如果用spdlog自带的宏打印，注意它有一个全局日志等级宏SPDLOG_ACTIVE_LEVEL，默认应该是info等级，可以在cmake中加一句话开启所有等级：
add_compile_definitions(SPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_TRACE)

六、自己封装了的代码

usespdlog.h

#pragma once
#include "spdlog/spdlog.h"
#include "spdlog/fmt/ostr.h"
#include "spdlog/fmt/bundled/printf.h"
#include "spdlog/sinks/rotating_file_sink.h"
#include "spdlog/sinks/daily_file_sink.h"
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/basic_file_sink.h"
#include "spdlog/async.h"
//是否使用fmt格式
//#define USE_FMT_LOG
class useSpdlog {
private:
    useSpdlog() = default;
    useSpdlog(const useSpdlog&) = delete;
    useSpdlog& operator=(const useSpdlog&) = delete;
public:
    static useSpdlog* config() {
        static useSpdlog a;
        return &a;
    }
    std::string global_debug_logger_name = "global_debug_logger";
    std::string global_info_logger_name = "global_info_logger";
    std::string global_error_logger_name = "global_error_logger";
    std::string global_debug_logger_path = "cvlogs/vm_global_debug.log";
    std::string global_info_logger_path = "cvlogs/vm_global_info.log";
    std::string global_error_logger_path = "cvlogs/vm_global_error.log";
    std::string default_pattern = "%^[%Y-%m-%d %H:%M:%S.%e] [%-8l] [%s:%#] %v%$";
    static std::shared_ptr<spdlog::logger> createAsyncRotatingFileLogger(spdlog::level::level_enum level, const std::string& logName = "spdlog", const std::string& logPath = "logs/spdlog.log", bool enableConsole = true, bool enableFile = true, const std::string& pattern = useSpdlog::config()->default_pattern)
    {
        assert(enableConsole || enableFile);
        auto p_logger = std::make_shared<spdlog::async_logger>(spdlog::async_logger(logName, {}, spdlog::thread_pool(), spdlog::async_overflow_policy::block));
        //auto p_logger = std::make_shared<spdlog::logger>(spdlog::logger(logName, {}));

        if (enableConsole)
        {
            auto console_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
            p_logger->sinks().push_back(console_sink);
        }
        if (enableFile)
        {
            auto file_sink = std::make_shared<spdlog::sinks::daily_file_sink_mt>(logPath, 0, 0, false, 15);
            p_logger->sinks().push_back(file_sink);
        }
        p_logger->set_level(level);
        p_logger->set_pattern(pattern);
        return p_logger;

    }
    static void initSpdlog(spdlog::level::level_enum level, bool enableconsole = true, bool enableFile = true)
    {
        //初始化线程池
        spdlog::init_thread_pool(100, 4);
        //专门记录trace和debug
        auto g_debug_logger = createAsyncRotatingFileLogger(spdlog::level::trace, useSpdlog::config()->global_debug_logger_name, useSpdlog::config()->global_debug_logger_path, enableconsole, enableFile);
        //专门记录info
        auto g_info_logger = createAsyncRotatingFileLogger(spdlog::level::info, useSpdlog::config()->global_info_logger_name, useSpdlog::config()->global_info_logger_path, enableconsole, enableFile, "%^[%Y-%m-%d %H:%M:%S.%e] [%-8l] %v%$");
        //专门记录 warn error cirtial
        auto g_error_logger = createAsyncRotatingFileLogger(spdlog::level::warn, useSpdlog::config()->global_error_logger_name, useSpdlog::config()->global_error_logger_path, enableconsole, enableFile);
        spdlog::register_logger(g_debug_logger);
        spdlog::register_logger(g_info_logger);
        spdlog::register_logger(g_error_logger);
        //每三秒刷新一下文件
        spdlog::flush_every(std::chrono::seconds(3));
        //设置全局日志等级
        spdlog::set_level(level);

    }

    static void register_AsyncRotatingFileLogger(spdlog::level::level_enum level, const std::string& logName, const std::string& logPath, bool enableConsole = true, bool enableFile = true, const std::string& pattern = useSpdlog::config()->default_pattern)
    {
        auto p_logger = createAsyncRotatingFileLogger(level, logName, logPath, enableConsole, enableFile, pattern);
        spdlog::register_logger(p_logger);

    }

    static void spd_printf_log(std::shared_ptr<spdlog::logger> logger, spdlog::level::level_enum level, char* file, int line, char* func, char* format, ...)
    {

        va_list args;
        va_start(args, format);
        char buff[1024];
        vsnprintf(buff, sizeof(buff), format, args);
        va_end(args);
        std::string msg = buff;
        logger->log(spdlog::source_loc{file, line, func}, level, msg);

    }

    static void set_level(spdlog::level::level_enum level)
    {
        spdlog::set_level(level);
    }
};
//printf格式
#define MODULE_LOG_TRACE_PRINTF(name,...) useSpdlog::spd_printf_log(spdlog::get(name),spdlog::level::level_enum::trace, __FILE__,__LINE__,__FUNCTION__, __VA_ARGS__)
#define MODULE_LOG_DEBUG_PRINTF(name,...) useSpdlog::spd_printf_log(spdlog::get(name),spdlog::level::level_enum::debug, __FILE__,__LINE__,__FUNCTION__, __VA_ARGS__)
#define MODULE_LOG_INFO_PRINTF(name,...) useSpdlog::spd_printf_log(spdlog::get(name),spdlog::level::level_enum::info, __FILE__, __LINE__, __FUNCTION__,__VA_ARGS__)
#define MODULE_LOG_WARN_PRINTF(name,...) useSpdlog::spd_printf_log(spdlog::get(name),spdlog::level::level_enum::warn, __FILE__, __LINE__,__FUNCTION__, __VA_ARGS__)
#define MODULE_LOG_ERROR_PRINTF(name,...) useSpdlog::spd_printf_log(spdlog::get(name),spdlog::level::level_enum::err, __FILE__, __LINE__, __FUNCTION__,__VA_ARGS__)
#define MODULE_LOG_CRITICAL_PRINTF(name,...) useSpdlog::spd_printf_log(spdlog::get(name),spdlog::level::level_enum::critical, __FILE__, __LINE__, __FUNCTION__,__VA_ARGS__)

//fmt格式
#define MODULE_LOG_TRACE_FMT(name,...) (spdlog::get(name))->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, spdlog::level::level_enum::trace, __VA_ARGS__)
#define MODULE_LOG_DEBUG_FMT(name,...) (spdlog::get(name))->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, spdlog::level::level_enum::debug, __VA_ARGS__)
#define MODULE_LOG_INFO_FMT(name,...) (spdlog::get(name))->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, spdlog::level::level_enum::info, __VA_ARGS__)
#define MODULE_LOG_WARN_FMT(name,...) (spdlog::get(name))->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, spdlog::level::level_enum::warn, __VA_ARGS__)
#define MODULE_LOG_ERROR_FMT(name,...) (spdlog::get(name))->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, spdlog::level::level_enum::err, __VA_ARGS__)
#define MODULE_LOG_CRITICAL_FMT(name,...) (spdlog::get(name))->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, spdlog::level::level_enum::critical, __VA_ARGS__)

//fmt和printf格式选择
#ifndef USE_FMT_LOG
#define MODULE_LOG_TRACE(name,...) MODULE_LOG_TRACE_PRINTF(name, __VA_ARGS__)
#define MODULE_LOG_DEBUG(name,...) MODULE_LOG_DEBUG_PRINTF(name, __VA_ARGS__)
#define MODULE_LOG_INFO(name,...) MODULE_LOG_INFO_PRINTF(name, __VA_ARGS__)
#define MODULE_LOG_WARN(name,...) MODULE_LOG_WARN_PRINTF(name, __VA_ARGS__)
#define MODULE_LOG_ERROR(name,...) MODULE_LOG_ERROR_PRINTF(name, __VA_ARGS__)
#define MODULE_LOG_CRITICAL(name,...) MODULE_LOG_CRITICAL_PRINTF(name, __VA_ARGS__)
#else
#define MODULE_LOG_TRACE(name,...) MODULE_LOG_TRACE_FMT(name, __VA_ARGS__)
#define MODULE_LOG_DEBUG(name,...) MODULE_LOG_DEBUG_FMT(name, __VA_ARGS__)
#define MODULE_LOG_INFO(name,...) MODULE_LOG_INFO_FMT(name, __VA_ARGS__)
#define MODULE_LOG_WARN(name,...) MODULE_LOG_WARN_FMT(name, __VA_ARGS__)
#define MODULE_LOG_ERROR(name,...) MODULE_LOG_ERROR_FMT(name, __VA_ARGS__)
#define MODULE_LOG_CRITICAL(name,...) MODULE_LOG_CRITICAL_FMT(name, __VA_ARGS__)
#endif

#define LOG_TRACE(...) MODULE_LOG_TRACE(useSpdlog::config()->global_debug_logger_name, __VA_ARGS__)
#define LOG_DEBUG(...) MODULE_LOG_DEBUG(useSpdlog::config()->global_debug_logger_name, __VA_ARGS__)
#define LOG_INFO(...) MODULE_LOG_INFO(useSpdlog::config()->global_info_logger_name, __VA_ARGS__)
#define LOG_WARN(...) MODULE_LOG_WARN(useSpdlog::config()->global_error_logger_name, __VA_ARGS__)
#define LOG_ERROR(...) MODULE_LOG_ERROR(useSpdlog::config()->global_error_logger_name, __VA_ARGS__)
#define LOG_CRITICAL(...) MODULE_LOG_CRITICAL(useSpdlog::config()->global_error_logger_name, __VA_ARGS__)

封装代码解释

  1. 我们用一个单例类usespdlog封装，这么做是为了能在头文件中方便的定义一些参数变量。
  2. initSpdlog初始化全局日志器，我们主要记录debug,info,error三种日志，将trace、debug合并，warn、error、critial合并。可以选择控制台显示或者记录到文件。文件是按日期保存，保存15天的日志，之后会回滚，删除最早的一个。
  3. createAsyncRotatingFileLogger 创建一个可以同时显示到控制台或者记录到文件的日志创建器，注册到spdlog，就可以用名字全局使用了。
  4. 自己定义了一些宏，不再使用spdlog自带的宏，通过USE_FMT_LOG开关可以选择使用FMT或printf风格写日志。不带MODUILE前缀的LOG_INFO等使用定义的全局日志记录器写日志，带MODULE前缀的MODULE_LOG_INFO等通过指定日至器写入日志。

使用示例

//初始化全局日志器
useSpdlog::initSpdlog(spdlog::level::level_enum::debug);		
//创建一个只在控制台显示的日志器
auto console_debug = useSpdlog::createAsyncRotatingFileLogger(spdlog::level::level_enum::debug, "console_debug", "", true, false, "[console debug] %v");
		spdlog::register_logger(console_debug);
LOG_INFO("123 %.2f",3.0);
MODULE_LOG_INFO("console_debug", "123 %s","33333");

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1838295.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

[Java基础揉碎]QQ聊天项目

[Java基础揉碎]QQ聊天项目

多用户系统演示 项目开发流程 多用户通讯需求 通讯系统整体分析 用户登录 新建项目 在建一个项目 user类 加上序列化, 加上UID增加兼容性 message类 消息类型 新建一个接口 客户端也拷贝过来 新建包和菜单界面类 工具类 新建一个类 新建一个类 回到这个类 写成这个名…
阅读更多...
【论文精读】树环水印Tree-Ring Watermarks：隐形且稳健的扩散图像的指纹

【论文精读】树环水印Tree-Ring Watermarks：隐形且稳健的扩散图像的指纹

文章目录 一、文章概览&#xff08;一&#xff09;主要工作&#xff08;二&#xff09;相关工作 二、具体方法&#xff08;一&#xff09;威胁模型&#xff08;二&#xff09;树轮水印概述&#xff08;三&#xff09;构造树轮水印键&#xff08;四&#xff09;提取用于水印检测…
阅读更多...
【unity笔记】四、Enviro- Sky and Weather插件使用

【unity笔记】四、Enviro- Sky and Weather插件使用

一、 简介 Enviro内置 RP、URP、HDRP&#xff0c;开箱即用。 动态天空 随附的天空系统经过精心设计&#xff0c;以实现最佳性能和灵活性。使用多种颜色渐变&#xff0c;而不是调整人工数字。为您的项目创建独特且非常逼真的天空非常简单&#xff01; 灯光 由 Enviro 控制的逼…
阅读更多...
APMCM亚太地区大学生数学建模竞赛奖励细则

APMCM亚太地区大学生数学建模竞赛奖励细则

APMCM亚太地区大学生数学建模竞赛&#xff08;以下简称竞赛&#xff09;是由北京图象图形学学会、亚太地区大学生数学建模竞赛组委会主办的面向全日制普通高等院校在校学生的学科竞赛活动。根据竞赛的宗旨&#xff0c;为了切实提供有价值的奖励政策&#xff0c;鼓励广大师生参与…
阅读更多...
6.深度卷积神经网络

6.深度卷积神经网络

目录 1.深度卷积神经网络ALexNet 2012AlexNetAlexNet架构AlexNet与LeNet复杂度对比总结代码实现2.使用块的网络VGG 2014 image竞猜第二VGG架构进度总结代码实现3.网络中的网络NiN全连接层的问题NiN块NiN架构总结代码实现4.含并行连结的网络（GoogLeNet）2014 image竞猜第一最好…
阅读更多...
制作ubuntu18.04 cuda10.2+ROS1+opencv 4.5.4的 docker镜像

制作ubuntu18.04 cuda10.2+ROS1+opencv 4.5.4的 docker镜像

如果搭建的版本高可以参考&#xff1a; https://gitlab.com/nvidia/container-images/l4t-jetpack.git 如果版本比较低&#xff0c;按照下面的步骤进行操作&#xff1a; 使用的硬件平台为Xavier NX&#xff0c;系统环境如下图&#xff1a; 搭建docker环境需求跟实际环境一致如下…
阅读更多...
逻辑地址 线性地址 物理地址 Linux kernel 内存管理设计

逻辑地址 线性地址 物理地址 Linux kernel 内存管理设计

linux kernel 2.6以后的MM&#xff0c;受到了兼容 risc arch cpu 的 MM 的启发&#xff0c;新的 MM 架构对 x86 上任务切换的效率上也有明显提高。 新的MM架构&#xff0c;GDT 不再随着进程的创建与结束而创建和删除 新的表项。 TSS段 也只有一个&#xff0c;进程切换时&…
阅读更多...
手持风扇哪个品牌好？五大手持风扇品牌推荐！

手持风扇哪个品牌好？五大手持风扇品牌推荐！

随着炎热夏季的到来&#xff0c;手持风扇已成为人们出行的必备清凉神器。然而&#xff0c;面对市场上众多品牌的手持风扇&#xff0c;如何选择一款既时尚又高效的产品成为了许多消费者的难题。为了解决这个困扰&#xff0c;我们精心挑选了五大手持风扇品牌进行推荐。这些品牌不…
阅读更多...
STM32 JTAG 模式和 SWD 模式的区别详解

STM32 JTAG 模式和 SWD 模式的区别详解

在调试和编程 STM32 微控制器时&#xff0c;使用 JTAG&#xff08;Joint Test Action Group&#xff09;模式和 SWD&#xff08;Serial Wire Debug&#xff09;模式是两种常见的方法。它们在接口需求、调试能力、引脚数量、通信速度等方面各有特点。我们一般采用的的下载器如ST…
阅读更多...
Window常用的脚本有哪些？快来看看有哪些是你正在用的！（欢迎评论补充~）

Window常用的脚本有哪些？快来看看有哪些是你正在用的！（欢迎评论补充~）

前言 在日常开发中&#xff0c;如果能熟练掌握以下这些使用频率很高的脚本&#xff0c;那工作起来真的是手拿把攥&#xff0c;事半功倍&#xff0c;接下来给大家介绍一些我们日常使用率很高的一些脚本&#xff01; 常用脚本(Batchfile & VBScript) 1.一键启动.bat 一次…
阅读更多...
MySQL数据库笔记（二）

MySQL数据库笔记（二）

第一章 单行函数 1.1 什么是函数 函数的作用是把我们经常使用的代码封装起来，需要的时候直接调用即可。这样既提高了代码效率，又提高了可维护性。在SQL中使用函数，极大地提高了用户对数据库的管理效率。 1.2 定义 操作数据对象。 接受参数返回一个结果。 只对一行进行…
阅读更多...
性能工具之 JMeter 常用组件介绍（八）

性能工具之 JMeter 常用组件介绍（八）

文章目录 一、Jmeter命令行启动二、Jmeter脚本录制 本文主要介绍JMeter命令行启动和脚本录制功能 一、Jmeter命令行启动 Jmeter有两种运行&#xff1a; 一种是采用的界面模式(GUI&#xff09;启动&#xff0c;会占用不少系统资源&#xff1b;另一种是命令行模式&#xff08;n…
阅读更多...
力扣hot100：31. 下一个排列

力扣hot100：31. 下一个排列

LeetCode&#xff1a;31. 下一个排列 字典序的大小排序&#xff1a; 从前往后对比&#xff0c;如果先出现更小字符的&#xff0c;字典序更小&#xff0c;如果有个字符串结束了&#xff0c;则它更小。string s "112233"和string t "1122334"&#xff0c;…
阅读更多...
训练营第四十二天| 583. 两个字符串的删除操作72. 编辑距离647. 回文子串516.最长回文子序列

训练营第四十二天| 583. 两个字符串的删除操作72. 编辑距离647. 回文子串516.最长回文子序列

583. 两个字符串的删除操作 力扣题目链接(opens new window) 给定两个单词 word1 和 word2&#xff0c;找到使得 word1 和 word2 相同所需的最小步数&#xff0c;每步可以删除任意一个字符串中的一个字符。 示例&#xff1a; 输入: "sea", "eat"输出: …
阅读更多...
71. UE5 RPG 实现敌人召唤技能

71. UE5 RPG 实现敌人召唤技能

在这一篇文章中&#xff0c;我们要实现敌人的召唤师能够召唤自己的仆从进行作战。 要实现这个技能&#xff0c;我们首先创建新的敌人蓝图&#xff0c;用于召唤。接着&#xff0c;我们将实现一个召唤技能基类&#xff0c;在基类中实现在召唤师的周围获取到可以生成的位置点&…
阅读更多...
数据结构与算法笔记：基础篇 - 分治算法：谈一谈大规模计算框架MapReduce中的分治思想

数据结构与算法笔记：基础篇 - 分治算法：谈一谈大规模计算框架MapReduce中的分治思想

概述 MapReduce 是 Google 大数据处理的三姐马车之一&#xff0c;另外两个事 GFS 和 Bigtable。它在倒排索引、PageRank 计算、网页分析等搜索引擎相关的技术中都有大量的应用。 尽管开发一个 MapReduce 看起来很高深。实际上&#xff0c;万变不离其宗&#xff0c;它的本质就…
阅读更多...
【nginx】 nginx核心功能

【nginx】 nginx核心功能

【nginx】 nginx核心功能 1.nginx核心功能 1. 反向代理 2. 负载均衡 3. 动静分离 4. nginx的高可用2. 反向代理 正向代理: 该服务器代理的是客户端&#xff0c;对于服务器来说&#xff0c;不知道真实客户端的ip。比如: 翻墙软件。 访问国外的服务器---使用了翻墙软件----对…
阅读更多...
响应式高端网站模板源码图库素材 资源下载平台源码

响应式高端网站模板源码图库素材 资源下载平台源码

源码介绍 亲测可用&#xff0c;可用于做娱乐网资源网&#xff0c;功能非常的齐全无任何加密也无任何后门&#xff01;响应式高端网站模板源码图库素材 资源下载平台源码&#xff08;可运营&#xff09; 页面很美观&#xff0c;堪比大型网站的美工&#xff0c;而且页面做的也很…
阅读更多...
GRIT论文阅读笔记

GRIT论文阅读笔记

一篇试图统一生成任务和编码任务的工作&#xff0c;就是把只能完成生成任务的GPT改成既能生成又能encode。思路其实很简单&#xff0c;就是在输入的时候添加instruction tokens来指引模型做representation还是generation&#xff0c;然后各自算损失。representation任务用的是d…
阅读更多...
【操作系统】操作系统实验02-生产者消费者程序改进

【操作系统】操作系统实验02-生产者消费者程序改进

1. 说明文档中原有程序实现的功能、实现方法。&#xff08;用语言、程序流程图、为原有程序添加注释等方式均可&#xff09; 1.//const.h 2.//定义宏变量 3.#ifndef CONST_H 4.#define CONST_H 5. 6.#define TRUE 1 7.#define FALSE 0 8.#define ERROR 0 9.#define OVERFLOW -…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023