spdlog学习—安装及基本使用

最新推荐文章于 2024-06-20 23:30:39 发布
最新推荐文章于 2024-06-20 23:30:39 发布
阅读量2.2k 收藏 49
点赞数 43
分类专栏： 开发框架学习 C++技术 文章标签： 学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/a12jggfdd/article/details/138808399
版权

文章目录

0、概念

Spdlog的优点：

  • 只包含头文件
  • 速度很快
  • 无需依赖第三方库
  • 支持跨平台
  • 支持多线程—线程安全
  • 可对日志文件进行循环输出
  • 可每日生成日志文件
  • 可支持控制台日志输出
  • 可选的异步输出
  • 可定义日志格式

1、安装使用方式

Spdlog安装方式：

  1. 包管理器安装方式（我当前使用的方式）
  • 由于我使用的系统是ubuntu，所以我就是用了包管理器的方式进行安装

sudo apt-get install libspdlog-dev

  1. 源码安装方式
  • 首先在Spdlog的github仓库中下载最新的源代码
git clone <https://github.com/gabime/spdlog.git>
  • 进入源代码目录然后创建"build"目录
cd spdlog
mkdir build
cd build
  • 依次在build目录下运行以下命令即可
cmake ..
make
sudo make install    // 安装命令

Spdlog使用：

  1. 首先第一步就是在代码中加入spdlog的头文件。
#include<spdlog/spdlog.h>
  • 之后就可以进行使用了

2、Spdlog代码编写

2.1、日志级别
  • 对于一个系统来说，显示信息的级别非常关键，我们先来了解以下spdlog中的几种级别
trace = SPDLOG_LEVEL_TRACE // 最低级（用来记录代码执行轨迹）
debug = SPDLOG_LEVEL_DEBUG //      （用来记录debug信息）
info = SPDLOG_LEVEL_INFO   // 在上面的测试例子中用过
warn = SPDLOG_LEVEL_WARN
err = SPDLOG_LEVEL_ERROR
critical = SPDLOG_LEVEL_CRITICAL
off = SPDLOG_LEVEL_OFF     // 最高级

注意：设定级别的作用就在于，你想在程序运行前指定我们需要记录哪些信息？我们可以自己控制日志记录的粒度。

2.2、控制台打印日志
  • 方式一：最简单的使用方式，将日志输出到控制台
#include<iostream>
#include<spdlog/spdlog.h>
#include<spdlog/sinks/stdout_sinks.h>

void stdout_easy()
{
    // 这个函数的意思其实就是根据参数“consoel”的名字在内部创建了一个logger，函数返回值就是这个logger的智能指针。
    auto console = spdlog::stdout_color_mt("console");
    // 所以我们可以直接通过智能指针调用名字对应“console”的logger对象的函数进行输出。
    console->info("hello world");
}
int main() 
{
    stdout_easy();
    return 0;
}

测试结果：
image.png

  • 方式二：我们也可以使用
#include<iostream>
#include<spdlog/spdlog.h>
#include<spdlog/sinks/stdout_sinks.h>

void stdout_example()
{
    // create a color multi-threaded logger
    //spdlog::stdout_color_mt("console")函数创建一个名字为console的console logger，
    //把这个logger注册到spdlog的全局注册表中，并且返回指向这个logger的指针（shared_ptr）
    auto console_stdout = spdlog::stdout_color_mt("console");  
    // 如果我们不知道上方创建函数返回的指针，我们也可以直接通过logger名称来获取对应logger 
    // 通过get来获取已经创建好的logger，获取方式通过指针名，同时使用info函数输出日志内容
    spdlog::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name)");
}

int main() 
{
    stdout_example();

    return 0;
}

运行结果：
image.png

2.3、文件保存日志
  • 下面的案例将日志记录保存到文件中，以便于长久保存。
  • basic_logger_mt只是spdlog中封装的其中一个日志记录器，还有很多其他的记录器。
#include<iostream>
#include<spdlog/spdlog.h>

int main()
{
    // 创建一个名为basic_logger的日志记录器，并且返回指针。
    // mt表示多线程,意味着多个线程中使用同一个日志记录器。
    // 需要注意的是在文件内添加数据是通过追加的形式进行的，并且如果没有创建文件会自动创建文件。
    auto basic_logger = spdlog::basic_logger_mt("basic_logger", "./logs/basic_log.txt");

    for(int i=0; i<10000; i++)
    {
        basic_logger->info("Test file logger{}", i);
    }

    return 0;
}

运行结果：（成功保存了日志）
image.png
image.png

2.4、自己创建日志记录器
  • 我们根据以上的学习之后，大体了解了其中的运行机制，所以我们就可以不使用他封装的日志记录器，而是使用他内部的logger对象封装适合自己的日志记录器。
  • 需要注意的是，所谓的不同的日志记录器其实就是不同的logger对象，那么用什么来区分不同的logger对象呢，就是用创建logger对象时传入的参数sink对象，这个sink对象标记着不同的类型，把他作为参数logger会根据sink对象类型的不同创建不同的日志记录器。
  • 这种方式有很大的用途，比如我们可以创建一个日志记录器，但是里边有多个类型的sink，从而可以一个logger能够实现多种效果。
#include<iostream>
#include<spdlog/spdlog.h>
#include<spdlog/sinks/sink.h>

void make_console_spdlog()
{
    auto console_level = std::make_shared<spdlog::sinks::stdout_sink_mt>();
    auto console = std::make_shared<spdlog::logger>("console", console_level);

    console->info("hello world");
}

int main()
{
    make_console_spdlog();

    return 0;
}

测试结果：
image.png

注意：通过手动创建的日志记录器是无法通过名字在spdlog中进行查找的，因为他并没有注册到spdlog的全局注册表。

void make_console_spdlog()
{
    auto console_level = std::make_shared<spdlog::sinks::stdout_sink_mt>();
    auto console = std::make_shared<spdlog::logger>("console", console_level);

    // 直接使用这种方式去获取日志记录器发生错误
    spdlog::get("console")->info("hello world!");
}

测试结果：（会直接报错）
image.png

  • 所以在创建日志记录器完成后，要将其注册到spdlog的全局注册表中
#include<iostream>
#include<spdlog/spdlog.h>
#include<spdlog/sinks/sink.h>

void make_console_spdlog()
{
    auto console_level = std::make_shared<spdlog::sinks::stdout_sink_mt>();
    auto console = std::make_shared<spdlog::logger>("console", console_level);
    // 将创建的日志记录器注册到全局注册表中
    spdlog::register_logger(console);

    // 直接使用这种方式去获取日志记录器发生错误
    spdlog::get("console")->info("hello world!");
}

int main()
{
    make_console_spdlog();
    return 0;
}

测试结果：
image.png

2.5、多记录器共享文件
  • 我们也可以创建多个日志记录器，共享同一文件读写。
#include<iostream>
#include<spdlog/spdlog.h>
#include<spdlog/sinks/file_sinks.h>

void multi_file_write()
{
    // 创建filesink，以便多个日志共享器共享。
    auto filesink = std::make_shared<spdlog::sinks::simple_file_sink_mt>("./logs/multilogger.txt");
    // 创建两个日志记录器来进行测试
    auto onelogger = std::make_shared<spdlog::logger>("onelogger", filesink);
    auto twologger = std::make_shared<spdlog::logger>("twologger", filesink);

    // 注册进spdlog的全局注册表
    spdlog::register_logger(onelogger);
    spdlog::register_logger(twologger);

    for(int i=0; i<100; i++)
    {
        onelogger->info("onelogger write:{}", i);
        twologger->info("twologger write:{}", i);
    }

}

int main()
{
    multi_file_write();
    return 0;
}

测试结果：（和预想的一样，交替在文件中打印）
image.png
image.png

2.6、日志分割
  • 在我们的应用程序有很多日志需要记录时，每个日志文件就会变得非常大，这样就会影响应用程序的性能以及稳定性。所以为了解决这个问题，可以使用Spdlog的日志分割功能。
  • rotating log 滚动日志，当日志文件超出规定大小时，会删除当前日志文件中所有内容，重新开始写入
#include<iostream>
#include<spdlog/spdlog.h>

void rotaing_file()
{
    // 首先定义要使用分割文件的大小和数量
    int max_size = 1048576*5;
    int file_size = 3;
    // 创建rotaing_logger_mt日志记录器
    auto rotaing_file = spdlog::rotating_logger_mt("rotaing_file", "./logs/rotaingLogger.txt", max_size, file_size);

    for(int i=0; i<100000; i++)
    {
        rotaing_file->info("rotaing file:{}", i);
    }

}


int main()
{
    rotaing_file();
    return 0;
}

测试结果：（和预想一致）
image.png
image.png

2.7、定时日志
  • Spdlog还可以实现定时创建文件存储日志的功能。
#include<iostream>
#include<spdlog/spdlog.h>

void daily_log()
{
    // 创建daily_log日志
    // 参数介绍 1日志记录器名称 2文件名 3时 4分
    auto daily_log = spdlog::daily_logger_mt("daily_log", "./logs/daily_log.txt", 16, 18);

    for(int i=0; i<100000; i++)
    {
        daily_log->info("daily log print {}", i);
    }
}

int main()
{
    daily_log();
    return 0;
}

测试结果：如果程序不退出，每天下午4点18分会自动创建新的文件。
image.png

2.8、其他函数介绍
  • 通过上面的学习，我们学会了spdlog其函数的基本使用方式，下面对spdlog中常用的一些函数和类进行介绍。
  1. level_enum：日志等级枚举，包括trace、info、debug、warn、err、critical、off、n_levels。
  2. sink：日志记录槽，进行底层操作（比如格式化内容，输出内容到控制台/文件）的类。spdlog自带的几种sinks已经能满足日常需求，也可以派生其基类设计新的sink以满足特殊的需求。sink类主要使用的函数包括：
    1. set_pattern(const std::string&)：设置日志输出格式
    2. set_level(level_enum)：设置日志输出的最低等级
    3. log(log_msg)：由logger自动调用，外部不会主动调用
  3. logger：日志记录器，被顶层调用来输出日志的类。一个logger对象中存储有多个sink，当调用logger的日志输出函数时，logger会调用自身存储的所有sink对象的log(log_msg)函数进行输出。与自身的sink对应，spdlog也自带了几种logger。logger类主要使用的函数包括：
    1. set_pattern(const std::string&)：设置logger包括的所有sink的日志输出内容格式。
    2. set_level(level_enum)：设置logger日志输出最低等级，如果logger包含的sink没有设置日志等级的话，则会为其设置日志等级。
    3. log(level_enum level, log_msg content)：按照level等级进行输出content，logger其中日志输出最低等级小于或等于level的sink会执行输出操作。
    4. info(content, arg1, arg2…)：按照trace等级进行输出，输出内容由content与后面的采纳数格式化组成。荣磊的函数还包括debug/trace/warn…。
  4. st/mt：对象版本，spdlog中logger对象和sink对象都有两种版本，一种是以st结尾的单线程版本，以及以mt结尾的多线程版本。
    1. st：单线程版本，不用加锁，效率更高。
    2. mt：多线程版本，用于多线程程序是线程安全的。
2.9、记录器包含多个sink
  • 像之前2.5多个记录器可以共享同一个文件sink，我们也可以将多个sink放在一个日志记录器logger中。
  • 结合这个案例使用2.8介绍的函数。
#include<iostream>
#include<spdlog/spdlog.h>
#include<spdlog/sinks/stdout_sinks.h>
#include<spdlog/sinks/file_sinks.h>


void multi_sink()
{
    // 创建两个sink，一个用于控制台输出，一个用于文件输出
    auto console_sink = std::make_shared<spdlog::sinks::stdout_sink_mt>();
    auto file_sink = std::make_shared<spdlog::sinks::simple_file_sink_mt>("./logs/multi_sink.txt");
    // 设置两者输出等级
    console_sink->set_level(spdlog::level::info);
    file_sink->set_level(spdlog::level::debug);

    // 将两种不同的sink放到一个日志输出器中
    auto multi_sink = std::make_shared<spdlog::logger>("multi_sink", spdlog::sinks_init_list({console_sink, file_sink}));
    multi_sink->set_level(spdlog::level::debug);
    // 输出不同等级日志测试
    multi_sink->info("hello world info");
    multi_sink->debug("helllo world debug");

}

int main()
{
    multi_sink();
    return 0;
}

测试：
image.png
image.png

参考：

ACrazyDragon
关注
  • 43
    点赞
  • 踩
  • 49
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spdlog库笔记 ：编译、安装
陨星落云的博客
05-25 1368
由于spdlog是基于头文件实现的，实现代码都位于include目录下的头文件中。（4）右键ALL_BUILD点击生成，从而编译目标，右键INSTALL点击生成，会安装库文件到前面CMAK_INSTALL_PREFIX指定的目录。将lib目录下的spdlogd.lib库文件路径包含进链接器的库文件路径，或者直接将lib目录下的文件拷贝到编译器MSVS的库文件目录。首先将头文件路径（include）包含进项目的搜索头文件路径，或者直接将include目录下的文件拷贝到编译器MSVC的头文件目录。
spdlog日志安装与使用
Yang的博客
01-14 1372
spdlog日志安装与使用
spdlog一个非常好用的C++日志库(一): 简介与使用
最新发布
红军不怕远征难，万水千山只等闲
06-20 1754
spdlog是一个开源的C++日志库，它提供了高性能和易用性的日志记录功能。它是为了满足现代C++应用程序的需要而创建的，可以在不同的平台上运行。 spdlog 是一个快速、异步的、header-only 的 C++ 日志库。它提供了简单易用的 API 并具有高性能和可扩展性。 spdlog因其高性能、易用性和丰富的功能，在C++开发中常被用作日志记录工具，帮助开发人员更好地追踪代码执行、排查问题、分析性能等。
「spdlog库」spdlog库的安装与简单使用
HAICHANG1105的博客
06-28 1646
「spdlog库」spdlog库的安装与简单使用
ubuntu spdlog 日志安装及使用
yuchunhai321的博客
03-29 2024
ubuntu spdlog 日志安装及使用
C++spdlog学习总结
qq_44629975的博客
08-15 6229
C++Spdlog学习笔记spdlog简介spdlog优点一般日志功能设计spdlog安装spdlog琐碎知识点总结spdlog程序测试（一）日志输出控制台（1）数据全部输出到控制台（2）指定某个等级以上的数据到控制台（二）输出格式的自定义方式 spdlog简介 （1）按照官方介绍，是一个高性能的C++日志组件，支持跨平台，兼容 C++11；一款开源的、快速的日志库； （2）spdlog是个只有头文件的库，只需要将头文件拷贝到你的工程就可以使用了，编译器需要支持C++11 它使用一个类似python的格式
spdlog入门教程（1）
mahuifa的博客
07-09 3916
日志库是一种用于记录和管理应用程序运行时信息的工具。它的主要作用是收集、存储和展示应用程序的日志信息，以便开发人员进行故障排查、性能优化和行为分析。
数据结构基本实现代码.zip
01-19
本压缩包“数据结构基本实现代码.zip”包含了一系列与数据结构相关的C语言实现，主要涵盖了一些基本的数据结构操作。下面将详细阐述每个文件中涉及的知识点。 1. **树的遍历.txt**：树是一种非线性的数据结构，广泛...
用c++写的 log 日志文件
01-16
此外，C++标准库并没有提供内置的日志框架，但在实际开发中，很多开发者会使用第三方库，如Glog、spdlog等，它们提供了更强大、更灵活的功能，例如异步日志处理、自定义格式化和日志过滤等。 总之，通过理解日志...
三次函数最大值的代码matlab-CPlusPlusStudy:C++学习代码
05-22
三次函数变量的代码matlab ...基本使用thread 。 参考： thread03_Mutex 使用mutex参考： thread04_TimeMutex 使用timed_mutex 。 参考： thread05_LockGuard 使用lock_guard 。 参考： thread06_UniqueLoc
log4cplus-0.9.1-docs.tar.gz
03-25
同时，了解其与其他日志库（如glog、spdlog）的异同，可以提升对日志管理的全局认识。 总结，log4cplus作为一个成熟的日志库，不仅提供了丰富的功能，还展现了良好的设计思想。通过深入学习"**log4cplus-0.9.1-docs...
spdlog.zip
10-31
spdlog-1.4的版本
cpp-spdlog超级快速C日志库
08-15
spdlog：超级快速C 日志库
c++使用spdlog整合读取配置文件使用
04-21
使用c++语言使用spdlog日志功能，创建新的message类进行包装，读取外部配置文件进行快速使用，好处可以不用每次都得make程序，只需要修改配置文件就可以直接运行程序
C C++日志及文件操作
01-03
// 使用spdlog例子 #include < spdlog/spdlog.h> auto logger = spdlog::stdout_color_mt("app"); logger->info("Hello, world!"); ``` 三、文件操作进阶 1. 文件指针（FILE*）：在C语言中，`fopen()`函数返回一...
spdlog日志库安装与示例
weixin_37846736的博客
05-28 3115
spdlog是一个开源的且只需要头文件即可使用的跨平台日志库，适用于c++11版本，源代码的地址为https://github.com/gabime/spdlog 使用步骤 1.下载源码到任意目录下 2.将源码的include中的spdlog文件夹整个复制到/usr/include/目录下，即/usr/include/spdlog，这样可以在调用的时候可以找到头文件spdlog相关的内容 3.测试代码如下 实现功能，在每天的指定时间点建立log文件，记录基本的信息 #include <iostrea
spdlog
強雲的博客
12-22 791
spdlog安装头文件安装静态库levelstdoutfilebasic file loggerrotating loggerasynchronous loggerCreate a multiple loggers all sharing the same file (sink) aka categoriesCreate a logger with multiple sinks, each sink with its own formatting and log level多线程线程不安全线程标志格式格式字
spdlog Features
好习惯成就伟大
09-29 371
Very fast (seebenchmarksbelow). Headers only or compiled Feature rich formatting, using the excellentfmtlibrary. Asynchronous mode (optional) Customformatting. Multi/Single threaded loggers. Various log targets: Rotating log files. Daily log ...
spdlog库学习
weixin_43233774的博客
06-02 2019
对spd日志库的文档的翻译，其中会其中一些不懂的点或者想法会进行标注。
ubuntu20.04 spdlog安装
09-16
在Ubuntu 20.04上安装spdlog可以按照以下步骤进行操作： 1. 首先，打开终端并运行以下命令更新软件包列表： ``` sudo apt update ``` 2. 接下来，运行以下命令安装spdlog的依赖项： ``` sudo apt install cmake ``` 3. 在终端中导航到您希望进行spdlog安装的目录，并克隆spdlog的GitHub存储库： ``` git clone https://github.com/gabime/spdlog.git ``` 4. 进入刚刚克隆下来的spdlog目录： ``` cd spdlog ``` 5. 创建一个新的目录来构建spdlog： ``` mkdir build cd build ``` 6. 运行cmake命令来配置构建： ``` cmake .. ``` 7. 运行make命令以构建spdlog： ``` make ``` 8. 最后，使用以下命令将spdlog安装到系统中： ``` sudo make install ``` 完成以上步骤后，您应该成功安装了spdlog。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值