用于格式化输出日志信息,这里的日志信息除了消息内容本身之外,还应该包括文件名用于格式化输出程序日志,方便从日志中定位程序运行过程中出现的问题。这里的日志除了日志内容本身之外,还应该包括文件名/行号,时间戳,线程/协程号,模块名称,日志级别等额外信息,甚至在打印致命的日志时,还应该附加程序的栈回溯信息,以便于分析和排查日志。协程号,模块名称,日志级别等额外信息,甚至在打印致命的日志时,还应该附加程序的栈回溯信息,以便于分析和排查问题。
从设计上看,一个完整的日志模块应该具备以下功能:1. 区分不同的日志级别,比如常的DEBUG
- 区分不同的级别,比如常的DEBUG/INFO/WARN/
...
- ERROR等级别。日志模块可以通过指定级别实现只输出某个级别以上的日志,这样可以灵活开关一些不重要的日志输出,比如程序在调试阶段可以设置一个较低的级别,以便看到更多的调度日志信息,程序发布之后可以设置一个较高的级别,以减少日志输出,提高性能。
...
- 区分不同的输出地。不同的日志可以输出到不同的位置,比如可以输出到标准输出,输出到文件,输出到syslog,输出到网络上的日志服务器等,甚至同一条日志可以同时输出到多个输出地。
- 区分不同的类别。日志可以分类并命名,一个程序的各个模块可以指定各自的日志类来输出日志,这样可以很方便地从日志中判断出当前日志是哪个程序模块输出的。
- 日志格式可灵活配置。可以按需指定日志消息是否包含文件名/行号、时间戳、线程/协程号、日志级别、启动时间等内容。
...
- 可通过配置文件的方式配置以上功能。
首先分析一个典型的C这里先通过一个典型的C++日志框架log4cpp,关于它的介绍和使用可参考官网:日志框架log4cpp来分析以上几点的运行。关于log4cpp的介绍和使用可参考官网:http://log4cpp.sourceforge.net/,下面是一个它的示例([todo:github地址]):
#include <iostream>,下面是一个它的示例:
| 代码块 |
|---|
#include <log4cpp/Category.hh> |
...
#include <log4cpp/Appender.hh> |
...
#include <log4cpp/OstreamAppender.hh> |
...
#include <log4cpp/FileAppender.hh> |
...
#include <log4cpp/Layout.hh> |
...
#include <log4cpp/PatternLayout.hh> |
...
// 日志器
...
#include <log4cpp/PropertyConfigurator.hh> int main() { // 日志类别 log4cpp::Category &root_logger = log4cpp::Category::getRoot(); |
...
// |
...
获取root日志器,root日志器名称默认为空 log4cpp::Category &file_logger = log4cpp::Category::getInstance("file_logger"); |
...
// 获取指定名称为file_logger的日志器 // 日志输出地 log4cpp::Appender *coutAppender = new log4cpp::OstreamAppender("cout", &std::cout); |
...
// 输出到终端 log4cpp::FileAppender *fileAppender = new log4cpp::FileAppender("file", "./log.txt"); |
...
// 输出到文件 // 日志格式 log4cpp::PatternLayout *coutPattern = new log4cpp::PatternLayout(); |
...
coutPattern->setConversionPattern("[%d{%Y-%m-%d %H:%M:%S:%l}] %p %m%n"); |
...
// 格式:[年:月:日 时:分:秒:毫秒] |
...
日志级别 |
...
日志内容 log4cpp::PatternLayout *filePattern = new log4cpp::PatternLayout(); filePattern->setConversionPattern("[%d{%Y-%m-%d %H:%M:%S:%l}] %R %c %p %m%n"); |
...
// 格式:[年:月:日 时:分:秒:毫秒] UTC秒数 日志器名称 日志级别 日志内容 // 绑定日志器和appender,设置日志器的输出级别 coutAppender->setLayout(coutPattern); |
...
root_logger.addAppender(coutAppender); |
...
root_logger.setPriority(log4cpp::Priority::INFO); |
...
fileAppender->setLayout(filePattern); |
...
file_logger.addAppender(fileAppender); |
...
file_logger.setPriority(log4cpp::Priority::ERROR); |
...
// |
...
支持c风格的日志打印和流式的日志打印 root_logger.debug("debug msg"); |
...
root_logger.debugStream() << "debug msg by stream"; |
...
root_logger.info("info msg"); |
...
root_logger.infoStream() << "info msg by stream"; |
...
root_logger.error("error msg"); |
...
root_logger.errorStream() << "err msg by stream"; |
...
file_logger.debug("debug msg"); |
...
file_logger.debugStream() << "debug msg by stream"; |
...
file_logger.info("info msg"); |
...
file_logger.infoStream() << "info msg by stream"; |
...
file_logger.error("error msg"); |
...
file_logger.errorStream() << "err msg by stream"; |
...
return 0; |
...
} |
对于log4cpp总结如下:
1. Category对应日志器类,使用 log4cpp::Category::getInstance() 获取指定名称的日志器实例,如果两个日志器名称相同,那么对应同一个日志器实例。
2. 使用Category的的setPriority()方法设置日志器的日志级别,日志级别使用log4cpp::Priority枚举值来表示。
3. 使用Appender来表示日志输出地,Appender可以细分为OstreamAppender和FileAppender等不同类型,一个Category可以有多个Appender,通过addAppender()方法为Category新增Appender。
4. 使用PatternLayout来表示日志的格式,通过字符串来表示,比如%d表示时间,后面可用{}指定具体的时间格式,%R表示UTC秒数,%c表示日志器名称,%p表示日志级别,%m表示日志消息等
5. PatternLayout和Appender绑定,Priority和Category绑定,也就是Appender不具备日志级别判断功能。
...