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

文章目录

  • 前言
  • 一、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");

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

PDF为何成为职场必备？编辑不求人，这几款工具助你一臂之力

PDF为何成为职场必备？编辑不求人，这几款工具助你一臂之力

不管是工作和学习&#xff0c;我们使用PDF文档的频率非常高&#xff0c;但是说起为什么要用PDF&#xff0c;却又只知其一不知其二。 为什么我们需要PDF&#xff1f; PDF&#xff0c;全称为Portable Document Format&#xff08;可移植文件格式&#xff09;&#xff0c;是一种…
阅读更多...
【电机】PID参数整定方法

【电机】PID参数整定方法

1 试凑法 采样周期的选择&#xff0c;要根据所设计的系统的具体情况&#xff0c;用试凑的方法&#xff0c;在试凑过程中根据各种合理的建议来预选采样周期&#xff0c;多次试凑&#xff0c;选择性能较好的一个作为最后的采样周期。早整定参数时必须要认真的观察系统的相应情况…
阅读更多...
低代码专题 | 低代码开发平台怎么收费，价格多少？一文揭秘！

低代码专题 | 低代码开发平台怎么收费，价格多少？一文揭秘！

低代码开发平台近几年真的火得一塌糊涂&#xff0c;不少企业都开始关注并尝试这种新的开发方式。 然而&#xff0c;关于低代码开发平台的收费问题&#xff0c;却是众说纷纭、信息零散。为了帮助大家更清晰地了解低代码开发平台的收费情况&#xff0c;这篇文章将进行全面的解读…
阅读更多...
【STM32】使用标准库检测按键

【STM32】使用标准库检测按键

按键检测使用到GPIO外设的基本输入功能。 1.硬件设计 作者使用的硬件没有按键模块。故使用了一个引脚模拟按键&#xff0c;将PWM1引脚拉低表示按键按下。思路如下&#xff1a;PWM1配置为输入&#xff0c;默认拉高&#xff0c;PWM1手动接地来模拟按下按键&#xff0c;此时PWM&a…
阅读更多...
如何做好亚马逊、速卖通自养号测评？这些细节很重要

如何做好亚马逊、速卖通自养号测评？这些细节很重要

亚马逊&#xff0c;作为电商领域的领军者&#xff0c;吸引了无数卖家入驻。在这片竞争激烈的土地上&#xff0c;Review成为了卖家们展现实力、赢得消费者信任的关键。 Review不仅反映了产品的质量和卖家的服务&#xff0c;更是消费者选择购买的重要因素。因此&#xff0c;对于卖…
阅读更多...
收入公平性评估方法

收入公平性评估方法

一、Gini系数## 1.1什么是基尼系数## 基尼系数是国际上用来综合考察居民内部收入分配差异状况的一个重要分析指标。每个人的收入有多有少&#xff0c;差距大时&#xff0c;基尼系数就高&#xff1b;差距小时&#xff0c;基尼系数就低。 1.2基本概念## 基尼系数表示在全部居民收…
阅读更多...
js语法---理解防抖原理和实现方法

js语法---理解防抖原理和实现方法

什么是防抖&#xff08;节流&#xff09; 在实际的网页交互中&#xff0c;如果一个事件高频率的触发&#xff0c;这会占用很多内存资源&#xff0c;但是实际上又并不需要监听触发如此多次这个事件&#xff08;比如说&#xff0c;在抢有限数量的优惠券时&#xff0c;用户往往会提…
阅读更多...
golang windows打包为linux可执行文件

golang windows打包为linux可执行文件

使用go的交叉编译功能 set GOOSlinux set GOARCHamd64然后再执行go build 可能会报异常, 所以贴出我的go env配置仅供参考 go env环境配置 D:\GoWork\src\go-tzv>go env set GO111MODULEauto set GOARCHamd64 set GOBIN …
阅读更多...
架构师篇-1、总体架构设计

架构师篇-1、总体架构设计

业务架构哲学本质 定位&#xff1a;赋予业务架构设计能力&#xff0c;具备业务架构设计思维模型&#xff0c;掌握业务架构哲学本质&#xff0c;形成以不变应万变的业务架构设计能力。 架构师所需要的能力&#xff1a; 带领业务成功通过框架思维赋能业务架构师知识体系构建掌…
阅读更多...
华北水利水电大学-C程序设计作业

华北水利水电大学-C程序设计作业

目录 基础题 1-1 分析 代码实现 1-2 分析 代码实现 1-3 分析 代码实现 1-4 ​编辑 分析 代码实现 1-5 分析 代码实现 1-6 分析 代码实现 基础题 1-1 从键盘输入10个学生的有关数据&#xff0c;然后把它们转存到磁盘文件上去。其中学生信息包括学号、姓名…
阅读更多...
学会python——制作一款天气查询工具（python实例七）

学会python——制作一款天气查询工具（python实例七）

目录 1、认识Python 2、环境与工具 2.1 python环境 2.2 Visual Studio Code编译 3、天气查询工具 3.1 代码构思 3.2 代码示例 3.3 运行结果 4、总结 1、认识Python Python 是一个高层次的结合了解释性、编译性、互动性和面向对象的脚本语言。 Python 的设计具有很强的…
阅读更多...
pip安装总是失败，如何配置pip安装源，让环境重获新生？

pip安装总是失败，如何配置pip安装源，让环境重获新生？

前情提要 公司新项目组报道后&#xff0c;因为用的是公司内网&#xff0c;安装完python 和pycharm 后&#xff0c;发现pip 下载安装包总是报错 具体解决 1.确认python 环境已经安装 2.在cmd中执行如下命令配置参数 pip config set global.index-url https://这里填写自己公…
阅读更多...
Linux 软件包管理器 yum

Linux 软件包管理器 yum

文章目录 yum是什么&#xff1f;Linux(centos)的生态yum的相关操作yum本地配置安装包lrzsz yum是什么&#xff1f; yum可以形象的比喻成一个下载安装管理的一个客户端&#xff0c;比如小米应用商店、华为应用商城 Linux中的安装包是有依赖关系的(比如下载游戏的时候有各种文件…
阅读更多...
神经网络模型---ResNet

神经网络模型---ResNet

一、ResNet 1.导入包 import tensorflow as tf from tensorflow.keras import layers, models, datasets, optimizersoptimizers是用于更新模型参数以最小化损失函数的算法 2.加载数据集、归一化、转为独热编码的内容一致 3.增加颜色通道 train_images train_images[...,…
阅读更多...
滑动窗口练习1-长度最小的子数组

滑动窗口练习1-长度最小的子数组

1.题目链接&#xff1a;209.长度最小的子数组 2.题目描述&#xff1a; 给定一个含有 n 个正整数的数组和一个正整数 target 。 找出该数组中满足其总和大于等于 target 的长度最小的 子数组 [numsl, numsl1, ..., numsr-1, numsr] &#xff0c;并返回其长度。如果不存在符合条…
阅读更多...
【机器学习】第9章 降维算法——PCA降维

【机器学习】第9章 降维算法——PCA降维

一、概念 1.PCA &#xff08;1&#xff09;主成分分析&#xff08;Principal ComponentAnalysis&#xff0c;PCA&#xff09;一种经典的线性降维分析算法。 &#xff08;2&#xff09;原理&#xff0c;这里以二维转一维为例&#xff0c;原来的平面变成了一条直线 这是三维变二…
阅读更多...
git 基本命令

git 基本命令

列出分支基本命令&#xff1a; git branch 如果我们要手动创建一个分支 。执行 git branch (branchname) 即可&#xff1a; git branch testing 切换到testing分支&#xff1a; git checkout testing 我们也可以使用 git checkout -b (branchname) 命令来创建新分支并立…
阅读更多...
1504 - Java多线程面试题

1504 - Java多线程面试题

少年&#xff0c;思无邪&#xff0c;最最动人。 1.Java中有哪几种创建线程的方式 1.1 继承Thread类 代码示例 class HelloWorld01 extends Thread{Overridepublic void run() {System.out.println("这是继承 Thread 类方式实现多线程!");} }public class CreateTh…
阅读更多...
Redis 高可用 sentinel

Redis 高可用 sentinel

简介 Sentinel提供了一种高可用方案来抵抗节点故障&#xff0c;当故障发生时Redis集群可以自动进行主从切换&#xff0c;程序可以不用重启。 Redis Sentinel集群可以看成是一个Zookeeper集群&#xff0c;他是Redis集群高可用的心脏&#xff0c;一般由3-5个节点组成&#xff0…
阅读更多...
从“产品的RFM分析”看如何探索“职业方向”

从“产品的RFM分析”看如何探索“职业方向”

我们在做产品分析时&#xff0c;经常会用到一种方法“产品的RFM分析”&#xff0c;它是一种客户细分和价值评估的常用方法&#xff0c;广泛应用于电子商务、零售和其他众多行业&#xff0c;它可以帮助企业和产品团队更好地理解用户行为&#xff0c;优化营销策略&#xff0c;提升…
阅读更多...
最新文章

Copyright @ 2022~2023