LINUX 日志操作c/c++ spdlog

spdlog

spdlog是一个开源的、快速的、仅有头文件的C++11 日志库，code地址在 https://github.com/gabime/spdlog ，目前最新的发布版本为0.14.0。它提供了向流、标准输出、文件、系统日志、调试器等目标输出日志的能力。它支持的平台包括Windows、Linux、Mac、Android。

spdlog特性：

(1)、非常快，性能是它的主要目标；

(2)、仅包括头文件；

(3)、日志的格式化处理使用开源的fmt库( https://github.com/fmtlib/fmt )；

(4)、可选的printf语法支持；

(5)、非常快的异步模式(可选)，支持异步写日志；

(6)、自定义格式；

(7)、条件日志；

(8)、多线程/单线程日志；(单线程为_st函数，多线程为_mt函数)

(9)、各种日志目标：可对日志文件进行循环输出；可每日生成日志文件；支持控制台日志输出(支持颜色)；系统日志；Windows debugger；较容易扩展自定义日志目标；

(10)、支持日志输出级别：阈值级别既可以在运行时也可以在编译时修改。

创建logger

1.使用spdlog自带的logger

 //<1.创建名称为LoggerName1、内容输出到控制台的单线程版本日志记录器
auto logger1 = spdlog::stdout_color_st("LoggerName1");

//<2.创建名称为LoggerName2、内容输出到Logs/BasicFileLog.txt的多线程版本日志记录器
auto logger2 = spdlog::basic_logger_mt("LoggerName2", "Logs/BasicFileLog.txt");

//<3.创建名称为LoggerName3、内容输出到Logs/RotatingFileLog.txt的多线程版本日志记录器
//参数1024*1024*5设置了文件最大容量为5mb，参数3设置了文件最大数量为3
//当日志文件存储超过5mb时，将重命名日志文件并且新增另外一个日志文件
//当日志文件数量超过3时，将删除第一个日志文件

auto logger3 = spdlog::rotating_logger_mt("LoggerName3", "Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);

//<4.创建名称为LoggerName4、内容输出到Logs/DailyFileLog.txt的多线程版本日志记录器
//参数2和30指定每天生成日志文件的时间为凌晨2点30分

auto logger4 = spdlog::daily_logger_mt("LoggerName4", "Logs/DailyFileLog.txt", 2, 30);

2.使用sink创建logger

//注：使用sink创建的logger需要执行spdlog::register(logger1)进行注册;
//<1.创建名称为LoggerName1、内容输出到控制台的单线程版本日志记录器
auto logger1 = std::make_shared<spdlog::logger>("LoggerName1", std::make_shared<spdlog::sinks::stdout_color_sink_st>());

//<2.创建名称为LoggerName2、内容输出到Logs/BasicFileLog.txt的多线程版本日志记录器
auto logger2 = std::make_shared<spdlog::logger>("LoggerName2", std::make_shared<spdlog::sinks::basic_file_sink_mt>("Logs/BasicFileLog.txt"));

//<3.创建名称为LoggerName3、内容输出到Logs/RotatingFileLog.txt的多线程版本日志记录器
//参数1024*1024*5设置了文件最大容量为5mb，参数3设置了文件最大数量为3
//当日志文件存储超过5mb时，将重命名日志文件并且新增另外一个日志文件
//当日志文件数量超过3时，将删除第一个日志文件
auto logger3 = std::make_shared<spdlog::logger>("LoggerName3", std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt",1024 * 1024 * 5, 3));

//<4.创建名称为LoggerName4、内容输出到Logs/DailyFileLog.txt的多线程版本日志记录器
//参数2和30指定每天生成日志文件的时间为凌晨2点30分
auto logger4 = std::make_shared<spdlog::logger>("LoggerName4", 
std::make_shared<spdlog::sinks::daily_file_sink_mt>("Logs/DailyFileLog.txt", 2,30));

创建使用同个sink的多个logger

//<1.创建sink
auto sink = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);

//<2.创建共同使用sink的多个logger，这些logger把内容一起输出到RotatingFileLog.txt中
auto logger1 = std::make_shared<spdlog::logger>("LoggerName1", sink);
auto logger2 = std::make_shared<spdlog::logger>("LoggerName2", sink);
auto logger3 = std::make_shared<spdlog::logger>("LoggerName3", sink);

4.创建使用多个sink的单个logger

//<1.创建多个sink
auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
auto sink2 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);
std::vector< spdlog::sink_ptr> sinks = { sink1,sink2 };

//<2.创建使用多个sink的单个logger，logger会把内容输出到不同位置，此处是控制台以及RotatingFileLog.txt
auto logger = std::make_shared<spdlog::logger>("LoggerName", sinks.begin(), sinks.end());

设置logger

 //<1.创建多个sink
auto sink1 = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
auto sink2 = std::make_shared<spdlog::sinks::rotating_file_sink_mt>("Logs/RotatingFileLog.txt", 1024 * 1024 * 5, 3);
std::vector< spdlog::sink_ptr> sinks = { sink1,sink2 };

//<2.创建使用多个sink的单个logger，logger会把内容输出到不同位置，此处是控制台以及RotatingFileLog.txt
auto logger = std::make_shared<spdlog::logger>("LoggerName", sinks.begin(), sinks.end());

//<3.设置sink的pattern和level
sink1->set_pattern("[%Y-%m-%d %H:%M:%S.%e][%l]>>>%v");
sink1->set_level(spdlog::level::debug);
sink2->set_pattern("[%Y-%m-%d][%L]%v");
sink2->set_level(spdlog::level::info);

//<4.输出日志
logger->debug("The message will only be shown on stdout.");//因为日志等级为debug，所以只会调用sink1进行输出
logger->info("The message will only be shown on stdout.");//日志等级为info，sink1与sink2都会进行输出

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xSjsxZ0I-1651800020847)(https://secure2.wostatic.cn/static/hkeAxXeeSVKAz1urPibj4w/image.png)]

3.3使用logger

1.通过spdlog::get(std::string)获取指定名称的logger进行使用

//<1.创建logger
//A.cpp
auto logger1 = std::make_shared<spdlog::logger>("LoggerName1", 
std::make_shared<spdlog::sinks::stdout_color_sink_mt>());
auto logger2 = std::make_shared<spdlog::logger>("LoggerName2", 
std::make_shared<spdlog::sinks::stdout_color_sink_mt>());
spdlog::register(logger2);
auto logger3 = spdlog::stdout_color_st("LoggerName3");

//<2.使用spdlog::get(std::string)获取logger
//B.cpp
auto logger1 = spdlog::get("LoggerName1");//logger1为空，因为logger1在A.cpp中没被注册
if (logger1)
{
    logger1->info("Hello world!");
}
auto logger2 = spdlog::get("LoggerName2");//logger2不为空，因为logger2在A.cpp中已被注册
if (logger2)
{
    logger2->info("Good night.");//输出
}
auto logger3 = spdlog::get("LoggerName3");//logger2不为空，因为spdlog自带的logger对象在构造时会自动注册
if (logger3)
{
    logger3->info("Good night.");//输出
}
console->info_if(true, "Welcome to spdlog conditional logging!");//if判断控制输出

2.通过spdlog::default_logger()调用默认的logger进行使用

 //<1.创建logger，并且将logger设置为默认的日志记录器
//A.cpp
auto logger = spdlog::stdout_color_mt("LoggerName");
spdlog::set_default_logger(logger);

//<2.使用spdlog::default_logger()获取默认的日志记录器
//B.cpp
auto logger = spdlog::default_logger();
if (logger)
{
    logger->info("Gigigigigi");//输出
}
spdlog::info("Taco Tuesday");//同样使用default_logger进行输出，更加方便的调用方式；未作default_logger是否为空的判断，会有程序中断的可能。

3.使用宏调用默认的logger的方法进行日志输出

#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_INFO
#include <spdlog/spdlog.h>
SPDLOG_INFO("This message will be shown.");//输出
SPDLOG_DEBUG("This message will not be shown.");//不输出，权限不够
SPDLOG_DEBUG_IF(console, true, "This is a debug log");//输出判断

4.使用fmt库格式化字符串

spdlog::info("Support for string.For example,hello,{}.", "Leborn Jame");//[2021-04-13 22:06:21.219] [info] Support for string.For example,hello,Leborn Jame.

spdlog::warn("Supprot for integer.For example,{:08d}.", 23);//[2021-04-13 22:07:48.865] [warning] Supprot for integer.For example,00000023.

spdlog::error("Support for float.For example,{:3.2}.", 1.23456);//[2021-04-13 22:07:48.865] [error] Support for float.For example,1.2.

spdlog::critical("Support for position parameter.For example,{1} and {0}.", "dog", "cat");//[2021-04-13 22:07:48.866] [critical] Support for position parameter.For example,cat and dog.

强制写出缓存区数据

//日志每次调用fwrite写入到文件缓存，即使同步模式，也需要flush_every来定时flush把缓冲区的内容强制的写出,
否则crash 时有丢失日志风险
spdlog::flush_every(std::chrono::seconds(3));
//设置当出发 err 或更严重的错误时立刻刷新日志到  disk 
nml_logger->set_level(spdlog::level::trace);
nml_logger->flush_on(spdlog::level::err);

enum level_enum
{
    trace = SPDLOG_LEVEL_TRACE, // 最低
    debug = SPDLOG_LEVEL_DEBUG,
    info = SPDLOG_LEVEL_INFO,
    warn = SPDLOG_LEVEL_WARN,
    err = SPDLOG_LEVEL_ERROR,
    critical = SPDLOG_LEVEL_CRITICAL, // 最高
    off = SPDLOG_LEVEL_OFF,
    n_levels
}
//环境变量初始化日志等级
 spdlog::cfg::load_env_levels();    // VS 属性—调试—环境 中设SPDLOG_LEVEL=info,mylogger=trace