本文主要是介绍c++日志库log4cplus快速入门小结,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
《c++日志库log4cplus快速入门小结》文章浏览阅读1.1w次,点赞9次,收藏44次。本文介绍Log4cplus,一种适用于C++的线程安全日志记录API,提供灵活的日志管理和配置控制。文章涵盖...
简介
log4j 用于Java,log4cplus从它衍生而来,用于c++。
用于c++的日志库还有很多,如 log4cxx等,可以根据实际js需求选择使用。
log4cplus 的地址:https://github.com/log4cplus/log4cplus。
log4cplus是一种易于使用的C ++日志记录API,可提供线程安全,灵活且任意粒度的日志管理和配置控制。
本文旨在快速使用。
日志等级
log4cplus 提供的日志等级如下:
ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF
举例来说,
- 如果定义了日志等级为 ERROR,那么只有标记为 ERROR, FATAL的日志信息才会被记录
- 如果等级为 DEBUG,则所有标记为 DEBUG/INFO/WARN/ERROR/FATAL 的日志才会被记录
- ALL和OFF级别用来将所有其他类型的级别分别切换为打开或关闭的标志,不会用于设置日志级别
配置文件
关于配置文件,说明几点:
- 日志输出到 appenders,appenders 可以是文件或者控制台,可以把输出当作cpp流的概念
- 一个日志类别可以关联到多个 appenders
- 所有的日志类别都是从抽象 root 类继承日志级别和 appender,除非另行定义
- 支持记录工作线程的id,用来分析线程行为
下面是一个配置文件的示例:
# 文件名:log4cplus.config ################################### ########Define log Levels########## ################################### # 告警级别由低到高排序: TRACE DEBUG INFO WARN ERROR FATAL #All classes - except those in log4cplus.logger.* - use DEBUG level to print information on file log4cplus.rootLogger=WARN, MyFileAppender #For MemoryCheck class I need to inspect all the details, and I want print information even to the console log4cplus.logger.MemoryCheck=INFO, MyConsoleAppender #For database stuff, I don't need to logging everything, it's enough printing only errors! log4cplus.logger.Databaseoperations=ERROR #############################www.chinasem.cn###### ########Define the Appenders####### ################################### #MyConsoleAppender: log4cplus.appender.MyConsoleAppender=log4cplus::ConsoleAppender log4cplus.appender.MyConsoleAppender.layout=log4cplus::PatternLayout log4cplus.appender.MyConsoleAppender.layout.ConversionPattern=[%-5p][%d] %m%n #MyFileAppender log4cplus.appender.MyFileAppender=log4cplus::RollingFileAppender log4cplus.appender.MyFileAppender.File=logging.txt log4cplus.appender.MyFileAppender.MaxFileSize=16MB log4cplus.appender.MyFileAppender.MaxBackupIndex=1 log4cplus.appender.MyFileAppendepythonr.layout=log4cplus::PatternLayout log4cplus.appender.MyFileAppender.layout.ConversionPattern=[%-5p][%D{%Y/%m/%d %H:%M:%S:%q}][%-l][%t] %m%n
其中,
- 每个logger可以添加级别和apppender,分别为第一个参数和第二个参数
- MemoryCheck和DatabaseOperations都继承rootLogger的属性,但它们各自的定义会与root共存,如 MemoryCheck 会打印 info 级别以上日志,并且同时输出到文件和控制台
- 直接使用根节点:
Logger logger = Logger::getRoot();
- 每个 apppender 可以设置日志输出位置、路径、layout等内容
- appender输出位置的输出位置可以是控制台、文件,其中文件可以是 FileAppender / RollingFileAppender / DailyRollingFileAppender / TimeBasedRollingFileAppender
- layout是控制日志输出格式的,格式有三种类型:
- SimpleLayout 是一种简单格式的布局器,在输出的原始信息之前加上LogLevel和一个"-"
- TTCCLayout 其格式由时间,线程ID,Logger和NDC 组成
- PatternLayout 是一种有词法分析功能的模式布局器,类似正则表达式。以“%”作为开头的特殊预定义标识符,将产生特殊的格式信息,如下:
(1)"%%",转义为% 。 (2)"%c",输出logger名称,如test.subtest 。也可以控制logger名称的显示层次,比如"%c{1}"时输出"test",其中数字表示层次。 (3)"%D",显示本地时间,比如:"2004-10-16 18:55:45",%d显示标准时间。 可以通过%d{...}定义更详细的显示格式,比如%d{%H:%M:%s}表示要显示小时:分钟:秒。大括号中可显示的预定义标识符如下: %a -- 表示礼拜几,英文缩写形式,比如"Fri" %A -- 表示礼拜几,比如"Friday" %b -- 表示几月份,英文缩写形式,比如"Oct" %B -- 表示几月份,"October" %c -- 标准的日期+时间格式,如"Sat Oct 16 18:56:19 2004" %d -- 表示今天是这个月的几号(1-31)"16" %H -- 表示当前时刻是几时(0-23),如"18" %I -- 表示当前时刻是几时(1-12),如"6" %j -- 表示今天是哪一天(1-366),如"290" %m -- 表示本月是哪一月(1-12),如"10" %M -- 表示当前时刻是哪一分钟(0-59),如"59" %p -- 表示现在是上午还是下午,AM or PM %q 编程-- 表示当前时刻中毫秒部分(0-999),如"237" %Q -- 表示当前时刻中带小数的毫秒部分(0-999.999),如 "430.732" %S -- 表示当前时刻的多少秒(0-59),如"32" %U -- 表示本周是今年的第几个礼拜,以周日为第一天开始计算(0-53),如 "41" %w -- 表示礼拜几,(0-6, 礼拜天为0),如"6" %W -- 表示本周是今年的第几个礼拜,以周一为第一天开始计算(0-53),如 "41" %x -- 标准的日期格式,如"10/16/04" %X -- 标准的时间格式,如"19:02:34" %y -- 两位数的年份(0-99),如"04" %Y -- 四位数的年份,如"2004" %Z -- 时区名,比如"GMT" (4)"%F",输出当前javascript记录器所在的文件名称,比如"main.cpp" (5)"%L",输出当前记录器所在的文件行号,比如"51" (6)"%l",输出当前记录器所在的文件名称和行号,比如"main.cpp:51" (7)"%m",输出原始信息。 (8)"%n",换行符。 (9)"%p",输出LogLevel,比如"DEBUG" (10)"%t",输出记录器所在的线程ID,比如 "1075298944" (11)"%x",嵌套诊断上下文NDC (nested diagnostic context) 输出,从堆栈中弹出上下文信息,NDC可以用对不同源的log信息(同时地)交叉输出进行区分。 (12)格式对齐,比如"%-10m"时表示左对齐,宽度是10,当然其它的控制字符也可以相同的方式来使用,比如"%-12d","%-5p"等等。
log4cplus提供一个类【PropertyConfigurator】来实现从文件读取配置,参数就是文件名。其他参数采用默认,初始化时使用。
使用
关于初始化
使用前必须初始化,代码如下:
#include <log4cplus/logger.h> #include <log4cplus/configurator.h> { log4cplus::initialize(); log4cplus::PropertyConfigurator::doConfigure(LOG4CPLUS_TEXT("log4cplus.config")); }
可以把这段代码放在main的开头,或者专门用来做初始化的类中。总之,在使用 Log4cplus 的实例前,必须初始化。
使用示例
如下代码:
#include <string> #include <log4cplus/logger.h> #include <log4cplus/configurator.h> #include <log4cplus/loggingMACros.h> using namespace log4cplus; using namespace std; int main() { log4cplus::initialize(); log4cplus::PropertyConfigurator::doConfigure(LOG4CPLUS_TEXT("log4cplus.config")); log4cplus::Logger m_log = log4cplus::Logger::getInstance(LOG4CPLUS_TEXT("MemoryCheck")); try { int x = 8; double y = 8.88; string allocated_memory = "here"; LOG4CPLUS_DEBUG(m_log, "x = " << x); LOG4CPLUS_DEBUG(m_log, "y = " << y); /* ... */ LOG4CPLUS_INFO(m_log, "Allocated = " << allocated_memory); } catch (std::bad_alloc &e) { /* I KNOW HOW TO DEAL WITH THIS ERROR!! */ /* ...code that handle the error is here... */ LOG4CPLUS_ERROR(m_log, e.what()); } catch (std::exception &e) { /* I KNOW HOW TO DEAL WITH THIS ERROR!! */ /* ...code that handle the error is here... */ LOG4CPLUS_ERROR(m_log, e.what()); } catch (...) { /* I DON'T KNOW HOW MANAGE THE ERROR!! */ LOG4CPLUS_FATAL(m_log, "unexpected error...use gdb core dump"); exit(-1); } int memory_remaining = 122; if (memory_remaining < 123) { LOG4CPLUS_WARN(m_log, "LOW MEMORY!!"); } return 0; }
因为 MemoryCheck 自己定义了 日志级别和 appender,它又从 rootlogger继承,所以,最终它的日志级别为 INFO,日志同时输出到控制台和文件中。
输出结果如下:
完整代码及编译请移步:log4cplus_demo
以上代码应该不用过多解释,从中可知各个日志等级的使用方式:
- TRACE:调试应用的详细步骤
- DEBUG:算法关键部分的相关信息
- INFO:应用的内部状态信息
- WARN:可以避免的内部状态信息
- ERROR:发生了错误,且应用程序知道如何处理它
- FATAL:发生了不可逆转的错误,程序无法继续运行
当然,以上分类只是根据项目需求,具体的日志级别分类应该结合实际需要,以及相对应的处理策略。
总结
以上介绍了Log4cplus 的基础使用,里面很多灵活地配置可以在使用中逐步了解。
总之,使用它可以简单便捷地建立起日志体系,步骤如下:
- 建立配置文件
- 初始化
- 开始使用
参考资料
log4cplus
Log4cplus Essential
到此这篇关于c++日志库log4cplus快速入门的文章就介绍到这了,更多相关c++日志库log4cplus内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!
这篇关于c++日志库log4cplus快速入门小结的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!