开源日志系统log4cplus(二)

最新推荐文章于 2023-03-02 20:31:31 发布

yyyy1985

最新推荐文章于 2023-03-02 20:31:31 发布

阅读量1.1k

点赞数

分类专栏：开源学习文章标签： object layout string 正则表达式 nested 文档

本文链接：https://blog.csdn.net/yyyy1985/article/details/4424508

版权

开源学习专栏收录该内容

6 篇文章 0 订阅

订阅专栏

本文介绍了三种控制输出格式的布局管理器的概念和使用情况，通过掌握这些知识，可以更有效地控制log系统输出尽可能贴近你需求的信息来。

				

### 如何控制输出消息的格式 ###

前面已经讲过，log4cplus通过布局器（Layouts）来控制输出的格式，log4cplus提供了三种类型的Layouts，

分别是SimpleLayout、PatternLayout、和TTCCLayout。其中：

1. SimpleLayout

是一种简单格式的布局器，在输出的原始信息之前加上LogLevel和一个"-"。

比如以下代码片段：

    ... ...

    /* step 1: Instantiate an appender object */

    SharedObjectPtr _append (new ConsoleAppender());

    _append->setName("append for test");

    /* step 2: Instantiate a layout object */

    std::auto_ptr  _layout(new log4cplus::SimpleLayout());

    /* step 3: Attach the layout object to the appender */

    _append->setLayout( _layout );

    /* step 4: Instantiate a logger object */

    Logger _logger = Logger::getInstance("test");

    /* step 5: Attach the appender object to the logger  */

    _logger.addAppender(_append);

     /* log activity */

    LOG4CPLUS_DEBUG(_logger, "This is the simple formatted log message...")

    

    ... ...

    

    

将打印结果：

DEBUG - This is the simple formatted log message...

2. PatternLayout

是一种有词法分析功能的模式布局器，一提起模式就会想起正则表达式，这里的模式和正则表达式类似，但是

远比后者简单，能够对预定义的标识符（称为conversion specifiers）进行解析，转换成特定格式输出。以下

代码片段演示了如何使用PatternLayout：

    ... ...

    /* step 1: Instantiate an appender object */

    SharedObjectPtr _append (new ConsoleAppender());

    _append->setName("append for test");

   

    /* step 2: Instantiate a layout object */

    std::string pattern = "%d{%m/%d/%y %H:%M:%S}  - %m [%l]%n";

    std::auto_ptr _layout(new PatternLayout(pattern));

    

    /* step 3: Attach the layout object to the appender */

    _append->setLayout( _layout );

    /* step 4: Instantiate a logger object */

    Logger _logger = Logger::getInstance("test_logger.subtest");

    /* step 5: Attach the appender object to the logger  */

    _logger.addAppender(_append);

     /* log activity */

    LOG4CPLUS_DEBUG(_logger, "teststr")

    

    ... ...

    

输出结果：

10/16/04 18:51:25  - teststr [main.cpp:51]

可以看出通过填写特定格式的模式字符串"pattern"，原始信息被包含到一堆有格式的信息当中了，这就使得

用户可以根据自身需要来定制显示内容。"pattern"可以包含普通字符串和预定义的标识符，其中：

（1）普通字符串，能够被直接显示的信息。

（2）预定义标识符，通过"%"与一个或多个字符共同构成预定义的标识符，能够产生出特定格式信息。

关于预定义标识符，log4cplus文档中提供了详细的格式说明，我每种都试了一下，以上述代码为例，根据不同

的pattern，各种消息格式使用情况列举如下：

（1）"%%"，转义为%, 即，std::string pattern = "%%" 时输出: "%"

（2）"%c"，输出logger名称，比如std::string pattern ="%c" 时输出: "test_logger.subtest"，

     也可以控制logger名称的显示层次，比如"%c{1}"时输出"test_logger"，其中数字表示层次。

（3）"%D"，显示本地时间，当std::string pattern ="%D" 时输出:"2004-10-16 18:55:45"，%d显示标准时间，

     所以当std::string pattern ="%d" 时输出 "2004-10-16 10:55:45" （因为我们是东8区，差8个小时啊）。

     可以通过%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"，输出当前记录器所在的文件名称，比如std::string pattern ="%F" 时输出: "main.cpp"

（5）"%L"，输出当前记录器所在的文件行号，比如std::string pattern ="%L" 时输出: "51"

（6）"%l"，输出当前记录器所在的文件名称和行号，比如std::string pattern ="%L" 时输出:

     "main.cpp:51"

（7）"%m"，输出原始信息，比如std::string pattern ="%m" 时输出: "teststr"，即上述代码中

     LOG4CPLUS_DEBUG的第二个参数，这种实现机制可以确保原始信息被嵌入到带格式的信息中。

（8）"%n"，换行符，没什么好解释的

（9）"%p"，输出LogLevel，比如std::string pattern ="%p" 时输出: "DEBUG"

（10）"%t"，输出记录器所在的线程ID，比如std::string pattern ="%t" 时输出: "1075298944"

（11）"%x"，嵌套诊断上下文NDC (nested diagnostic context) 输出，从堆栈中弹出上下文信息，NDC可以用对

      不同源的log信息（同时地）交叉输出进行区分，关于NDC方面的详细介绍会在下文中提到。

（12）格式对齐，比如std::string pattern ="%-10m"时表示左对齐，宽度是10，此时会输出"teststr   "，当

      然其它的控制字符也可以相同的方式来使用，比如"%-12d"，"%-5p"等等（刚接触log4cplus文档时还以为

      "%-5p"整个字符串代表LogLevel呢，呵呵）。

      

3. TTCCLayout

是在PatternLayout基础上发展的一种缺省的带格式输出的布局器， 其格式由时间，线程ID，Logger和NDC 组

成（consists of time, thread, Logger and nested diagnostic context information, hence the name），

因而得名（怎么得名的？Logger里哪里有那个"C"的缩写啊！名字起得真够烂的，想扁人）。提供给那些想显示

典型的信息（一般情况下够用了）又懒得配置pattern的同志们。

TTCCLayout在构造时有机会选择显示本地时间或GMT时间，缺省是按照本地时间显示：

TTCCLayout::TTCCLayout(bool use_gmtime  = false)

以下代码片段演示了如何使用TTCCLayout：

    ... ...

    /* step 1: Instantiate an appender object */

    SharedObjectPtr _append (new ConsoleAppender());

    _append->setName("append for test");

    /* step 2: Instantiate a layout object */

    std::auto_ptr _layout(new TTCCLayout());

    /* step 3: Attach the layout object to the appender */

    _append->setLayout( _layout );

    /* step 4: Instantiate a logger object */

    Logger _logger = Logger::getInstance("test_logger");

    /* step 5: Attach the appender object to the logger  */

    _logger.addAppender(_append);

     /* log activity */

    LOG4CPLUS_DEBUG(_logger, "teststr")

    

    ... ...

    

输出结果：

10-16-04 19:08:27,501 [1075298944] DEBUG test_logger <> - teststr

				

当构造TTCCLayout对象时选择GMT时间格式时：

    ... ...

    

    /* step 2: Instantiate a layout object */

    std::auto_ptr _layout(new TTCCLayout(true));

    

    ... ...

    

输出结果：

10-16-04 11:12:47,678 [1075298944] DEBUG test_logger <> - teststr

				

本文介绍了控制log信息格式的相关知识，下一部分将详细介绍log信息的几种文件操作方式。

将log信息记录到文件应该说是日志系统的一个基本功能，log4cplus在此基础上，提供了更多的功能，可以按照你预先设定的大小来决定是否转储，当超过该大小，后续log信息会另存到新文件中，依次类推；或者按照日期来决定是否转储。本文将详细介绍这些用法。

				

### 如何将log记录到文件 ###

我们在例5中给出了一个将log记录到文件的例子，用的是FileAppender类实现的，log4cplus提供了三个类用于

文件操作，它们是FileAppender类、RollingFileAppender类、DailyRollingFileAppender类。

1. FileAppender类

实现了基本的文件操作功能，构造函数如下：

FileAppender(const log4cplus::tstring& filename,

                     LOG4CPLUS_OPEN_MODE_TYPE mode = LOG4CPLUS_FSTREAM_NAMESPACE::ios::trunc,

                     bool immediateFlush = true);

                     

filename       : 文件名

mode           : 文件类型，可选择的文件类型包括app、ate、binary、in、out、trunc，因为实际上只是对

                 stl的一个简单包装，呵呵，这里就不多讲了。缺省是trunc，表示将先前文件删除。

immediateFlush ：缓冲刷新标志，如果为true表示每向文件写一条记录就刷新一次缓存，否则直到FileAppender

                 被关闭或文件缓存已满才更新文件，一般是要设置true的，比如你往文件写的过程中出现

                 了错误（如程序非正常退出），即使文件没有正常关闭也可以保证程序终止时刻之前的所有

                 记录都会被正常保存。

FileAppender类的使用情况请参考例5，这里不再赘述。

				

2. RollingFileAppender类

构造函数如下：

log4cplus::RollingFileAppender::RollingFileAppender(const log4cplus::tstring& filename,

                                                    long maxFileSize,

                                                    int maxBackupIndex,

                                                    bool immediateFlush)

filename       : 文件名

maxFileSize    : 文件的最大尺寸

maxBackupIndex : 最大记录文件数

immediateFlush : 缓冲刷新标志

                                                    

RollingFileAppender类可以根据你预先设定的大小来决定是否转储，当超过该大小，后续log信息会另存到新

文件中，除了定义每个记录文件的大小之外，你还要确定在RollingFileAppender类对象构造时最多需要多少个

这样的记录文件(maxBackupIndex+1)，当存储的文件数目超过maxBackupIndex+1时，会删除最早生成的文件，

保证整个文件数目等于maxBackupIndex+1。然后继续记录，比如以下代码片段：

    ... ...

    

    #define LOOP_COUNT 200000

    

    SharedAppenderPtr _append(new RollingFileAppender("Test.log", 5*1024, 5));

    _append->setName("file test");

    _append->setLayout( std::auto_ptr(new TTCCLayout()) );

    Logger::getRoot().addAppender(_append);

    Logger root = Logger::getRoot();

    Logger test = Logger::getInstance("test");

    Logger subTest = Logger::getInstance("test.subtest");

    for(int i=0; i    {

        NDCContextCreator _context("loop");

        LOG4CPLUS_DEBUG(subTest, "Entering loop #" << i)

    }

    

    ... ...

运行结果：

运行后会产生6个输出文件，Test.log、Test.log.1、Test.log.2、Test.log.3、Test.log.4、Test.log.5

其中Test.log存放着最新写入的信息，而最后一个文件中并不包含第一个写入信息，说明已经被不断更新了。

需要指出的是，这里除了Test.log之外，每个文件的大小都是200K,而不是我们想像中的5K，这是因为

log4cplus中隐含定义了文件的最小尺寸是200K，只有大于200K的设置才生效，<= 200k的设置都会被认为是

200K.

				

3. DailyRollingFileAppender类

构造函数如下：

DailyRollingFileAppender::DailyRollingFileAppender(const log4cplus::tstring& filename,

                                                   DailyRollingFileSchedule schedule,

                                                   bool immediateFlush,

                                                   int maxBackupIndex)

                                                   

filename       : 文件名

schedule       : 存储频度

immediateFlush : 缓冲刷新标志

maxBackupIndex : 最大记录文件数

DailyRollingFileAppender类可以根据你预先设定的频度来决定是否转储，当超过该频度，后续log信息会另存

到新文件中，这里的频度包括：MONTHLY（每月）、WEEKLY（每周）、DAILY（每日）、TWICE_DAILY（每两天）、

HOURLY（每时）、MINUTELY（每分）。maxBackupIndex的含义同上所述，比如以下代码片段：

    ... ...

    

    SharedAppenderPtr _append(new DailyRollingFileAppender("Test.log", MINUTELY, true, 5));

    _append->setName("file test");

    _append->setLayout( std::auto_ptr(new TTCCLayout()) );

    Logger::getRoot().addAppender(_append);

    Logger root = Logger::getRoot();

    Logger test = Logger::getInstance("test");

    Logger subTest = Logger::getInstance("test.subtest");

    for(int i=0; i    {

        NDCContextCreator _context("loop");

        LOG4CPLUS_DEBUG(subTest, "Entering loop #" << i)

    }

    

    ... ...

				

运行结果：

运行后会以分钟为单位，分别生成名为Test.log.2004-10-17-03-03、Test.log.2004-10-17-03-04和

Test.log.2004-10-17-03-05这样的文件。

需要指出的是，刚看到按照频度（如HOURLY、MINUTELY）转储这样的概念，以为log4cplus提供了内部定时器，

感觉很奇怪，因为日志系统不应该主动记录，而loging事件总是应该被动触发的啊。仔细看了源代码后才知道

这里的"频度"并不是你写入文件的速度，其实是否转储的标准并不依赖你写入文件的速度，而是依赖于写入

的那一时刻是否满足了频度条件，即是否超过了以分钟、小时、周、月为单位的时间刻度，如果超过了就另存。

本部分详细介绍log信息的几种文件操作方式，下面将重点介绍一下如何有选择地控制log信息的输出。

yyyy1985

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录