![]()
綠盟科技
2003 年 9 月
log4cpp是個(gè)基于LGPL的開源項(xiàng)目，是基于優(yōu)秀的日志處理跟蹤項(xiàng)目Java語(yǔ)言的log4j移植過(guò)來(lái)的。log4j介紹的文檔很多，在java領(lǐng)域使用的也比較廣泛，而這個(gè)功能強(qiáng)大的庫(kù)對(duì)國(guó)內(nèi)的C++語(yǔ)言開發(fā)人員卻使用的不多。這里從開發(fā)人員使用的角度介紹這個(gè)庫(kù)，使開發(fā)人員用最少的代價(jià)盡快掌握這種技術(shù)。下面先簡(jiǎn)單介紹一下這個(gè)項(xiàng)目的優(yōu)點(diǎn)（也是log4j的優(yōu)點(diǎn)），然后分原理，手動(dòng)使用步驟，配置文件驅(qū)動(dòng)方式使用步驟，其他考慮等方面進(jìn)行討論。以下討論基于log4cpp0.3.4b。
0. 優(yōu)點(diǎn)
提供應(yīng)用程序運(yùn)行上下文，方便跟蹤調(diào)試；
可擴(kuò)展的、多種方式記錄日志，包括命令行、文件、回卷文件、內(nèi)存、syslog服務(wù)器、Win事件日志等；
可以動(dòng)態(tài)控制日志記錄級(jí)別，在效率和功能中進(jìn)行調(diào)整；
所有配置可以通過(guò)配置文件進(jìn)行動(dòng)態(tài)調(diào)整；
多語(yǔ)言支持，包括Java（log4j），C++（log4cpp、log4cplus），C（log4c），python（log4p）等；
...
1. 原理
log4cpp有3個(gè)主要的組件：categories（類別）、appenders（附加目的地）、和 layouts（布局）。（為了方便大家理解，文中盡量使用英文原詞）
layout類控制輸出日志消息的顯示樣式（看起來(lái)像什么）。log4cpp當(dāng)前提供以下layout格式：
log4cpp::BasicLayout // 以"時(shí)間戳 優(yōu)先級(jí)（priority，下文介紹）
// 類別（category，下文介紹）
// NDC標(biāo)簽（nested diagnostic contexts 下文介紹）: 日志信息"。
// 如：1056638652 INFO main : This is some info
log4cpp::PatternLayout // 讓用戶根據(jù)類似于 C 語(yǔ)言 printf 函數(shù)的轉(zhuǎn)換模式來(lái)指定輸出格式。格式定義見代碼附帶文檔。
log4cpp::SimpleLayout // 以"優(yōu)先級(jí)（priority） - 日志信息"格式顯示。
|
appender類用來(lái)輸出日志（被layout格式化后的）到一些設(shè)備上。比如文件、syslog服務(wù)、某個(gè)socket等。可以定義自己的 appender類輸出日志信息到別的設(shè)備上，比如應(yīng)用自身的日子處理進(jìn)程、數(shù)據(jù)庫(kù)等。appender和layout的關(guān)系是layout附在 appender上，appender類調(diào)用layout處理完日志消息后，記錄到某個(gè)設(shè)備上。log4cpp當(dāng)前提供以下appender：
log4cpp::IdsaAppender // 發(fā)送到IDS或者logger, 詳細(xì)見 http://jade.cs.uct.ac.za/idsa/
log4cpp::FileAppender // 輸出到文件
log4cpp::RollingFileAppender // 輸出到回卷文件，即當(dāng)文件到達(dá)某個(gè)大小后回卷
log4cpp::OstreamAppender // 輸出到一個(gè)ostream類
log4cpp::RemoteSyslogAppender // 輸出到遠(yuǎn)程syslog服務(wù)器
log4cpp::StringQueueAppender // 內(nèi)存隊(duì)列
log4cpp::SyslogAppender // 本地syslog
log4cpp::Win32DebugAppender // 發(fā)送到缺省系統(tǒng)調(diào)試器
log4cpp::NTEventLogAppender // 發(fā)送到win 事件日志
|
category 類真正完成記錄日志功能，兩個(gè)主要組成部分是appenders和priority（優(yōu)先級(jí)）。優(yōu)先級(jí)控制哪類日志信息可以被這個(gè)category記錄，當(dāng)前優(yōu)先級(jí)分為：NOTSET, DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT 或 FATAL/EMERG 。每個(gè)日志信息有個(gè)優(yōu)先級(jí)，每個(gè)category有個(gè)優(yōu)先級(jí)，當(dāng)消息的優(yōu)先級(jí)大于等于category的優(yōu)先級(jí)時(shí)，這個(gè)消息才會(huì)被category記錄，否則被忽略。優(yōu)先級(jí)的關(guān)系如下。category類和appender的關(guān)系是，多個(gè)appender附在category上，這樣一個(gè)日志消息可以同時(shí)輸出到多個(gè)設(shè)備上。
NOTSET < DEBUG < INFO < NOTICE < WARN < ERROR < CRIT < ALERT < FATAL = EMERG
category被組織成一個(gè)樹，子category創(chuàng)建時(shí)優(yōu)先級(jí)缺省NOTSET，category缺省會(huì)繼承父category的 appender。而如果不希望這種appender的繼承關(guān)系，log4cpp允許使用additivity 標(biāo)簽，為false時(shí)新的appender取代category的appender列表。
為了更好的理解上面的概念下面以手動(dòng)使用方式舉例。
2. 手動(dòng)使用步驟
手動(dòng)使用log4cpp的基本步驟如下：
- 實(shí)例化一個(gè)layout 對(duì)象；
- 初始化一個(gè)appender 對(duì)象；
- 把layout對(duì)象附著在appender對(duì)象上；
- 調(diào)用log4cpp::Category::getInstance("name"). 實(shí)例化一個(gè)category對(duì)象；
- 把a(bǔ)ppender對(duì)象附到category上（根據(jù)additivity的值取代其他appender或者附加在其他appender后）。
- 設(shè)置category的優(yōu)先級(jí)；
// FileName: test_log4cpp1.cpp
// Test log4cpp by manual operation.
// Announce: use as your own risk.
// Compile : g++ -otest1 -llog4cpp test_log4cpp1.cpp
// Run : ./test1
// Tested : RedHat 7.2 log4cpp0.3.4b
// Author : liqun (liqun@nsfocus.com)
// Data : 2003-6-27
#include "log4cpp/Category.hh"
#include "log4cpp/FileAppender.hh"
#include "log4cpp/BasicLayout.hh"
int main(int argc, char* argv[])
{
// 1實(shí)例化一個(gè)layout 對(duì)象
log4cpp::Layout* layout =
new log4cpp::BasicLayout();
// 2. 初始化一個(gè)appender 對(duì)象
log4cpp::Appender* appender = new
log4cpp::FileAppender("FileAppender",
"./test_log4cpp1.log");
// 3. 把layout對(duì)象附著在appender對(duì)象上
appender->setLayout(layout);
// 4. 實(shí)例化一個(gè)category對(duì)象
log4cpp::Category& warn_log =
log4cpp::Category::getInstance("mywarn");
// 5. 設(shè)置additivity為false，替換已有的appender
warn_log.setAdditivity(false);
// 5. 把a(bǔ)ppender對(duì)象附到category上
warn_log.setAppender(appender);
// 6. 設(shè)置category的優(yōu)先級(jí)，低于此優(yōu)先級(jí)的日志不被記錄
warn_log.setPriority(log4cpp::Priority::WARN);
// 記錄一些日志
warn_log.info("Program info which cannot be wirten");
warn_log.debug("This debug message will fail to write");
warn_log.alert("Alert info");
// 其他記錄日志方式
warn_log.log(log4cpp::Priority::WARN, "This will be a logged warning");
log4cpp::Priority::PriorityLevel priority;
bool this_is_critical = true;
if(this_is_critical)
priority = log4cpp::Priority::CRIT;
else
priority = log4cpp::Priority::DEBUG;
warn_log.log(priority,"Importance depends on context");
warn_log.critStream() << "This will show up << as "
<< 1 << " critical message"
<< log4cpp::CategoryStream::ENDLINE;
// clean up and flush all appenders
log4cpp::Category::shutdown();
return 0;
}
|
3. 配置文件驅(qū)動(dòng)方式使用步驟
另一個(gè)非常優(yōu)秀的特征就是通過(guò)讀取配置文件，確定category、appender、layout等對(duì)象。也是我們非常推薦的使用方式，可以靈活地通過(guò)配置文件定義所有地對(duì)象及其屬性，不用重新編碼，動(dòng)態(tài)更改日志記錄的策略。
Log4cpp主要提供了 log4cpp::PropertyConfigurator 和log4cpp::SimpleConfigurator兩種機(jī)制（文件格式），但 log4cpp::SimpleConfigurator將來(lái)不再支持了，而且格式非常簡(jiǎn)單，這里就不多說(shuō)明，自己看源碼吧。
配置文件的格式和log4j的配置文件一樣，是標(biāo)準(zhǔn)的java屬性文件格式。下面是附帶的例子配置文件：
# a simple test config
#定義了3個(gè)category sub1, sub2, sub1.sub2
log4j.rootCategory=DEBUG, rootAppender
log4j.category.sub1=,A1
log4j.category.sub2=INFO
log4j.category.sub1.sub2=ERROR, A2
# 設(shè)置sub1.sub2 的additivity屬性
log4j.additivity.sub1.sub2=false
#定義rootAppender類型和layout屬性
log4j.appender.rootAppender=org.apache.log4j.ConsoleAppender
log4j.appender.rootAppender.layout=org.apache.log4j.BasicLayout
#定義A1的屬性
log4j.appender.A1=org.apache.log4j.FileAppender
log4j.appender.A1.fileName=A1.log
log4j.appender.A1.layout=org.apache.log4j.SimpleLayout
#定義A2的屬性
log4j.appender.A2=org.apache.log4j.ConsoleAppender
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern=The message '%m' at time %d%n
|
配置文件語(yǔ)法如下，不是很規(guī)范，結(jié)合上面的例子，應(yīng)該可以看懂。
log4j / log4cpp . [category / appender].[category or appender 's name].[category or appender 's property]
= [Appender / Layout / property's value / Priority, appender name1 [appender name2 ...]]
[appender]
{ConsoleAppender}
{FileAppender} // 當(dāng)appender的類型是FileAppender時(shí)，可以定義它下面的屬性。
[fileName] string foobar // 格式是：屬性名 值的類型 缺省值
[append] bool true
{RollingFileAppender}
[fileName] string foobar
[maxFileSize] num 10*1024*1024
[maxBackupIndex] num 1
[append] bool true
{SyslogAppender}
[syslogName] string syslog
[syslogHost] string localhost
[facility] num -1 // * 8 to get LOG_KERN, etc. compatible values.
[portNumber] num -1
{IdsaAppender}
[idsaName] string foobar
{Win32DebugAppender}
{NTEventLogAppender}
[source] string foobar
[threshold] string "" // 全部
// 如果此類型appender需要layout，必須定義此appender的下面屬性
[layout]
{BasicLayout}
{SimpleLayout}
{PatternLayout} // 當(dāng)layout的值是BasicLayout時(shí)，需要定義下面的屬性。
[ConversionPattern]
[rootCategory]
[additivity]
[category name] bool true
|
基本使用步驟是：
- 讀取解析配置文件；
- 實(shí)例化category對(duì)象；
- 正常使用這些category對(duì)象進(jìn)行日志處理；
下面是個(gè)簡(jiǎn)單的使用代碼，使用起來(lái)是非常方便的：
// FileName: test_log4cpp2.cpp
// Test log4cpp by config file.
// Announce: use as your own risk.
// Compile : g++ -llog4cpp test_log4cpp2.cpp
// Run : ./a.out
// Tested : RedHat 7.2 log4cpp0.3.4b
// Author : liqun (liqun@nsfocus.com)
// Data : 2003-6-27
#include "log4cpp/Category.hh"
#include "log4cpp/PropertyConfigurator.hh"
int main(int argc, char* argv[])
{
// 1 讀取解析配置文件
// 讀取出錯(cuò), 完全可以忽略，可以定義一個(gè)缺省策略或者使用系統(tǒng)缺省策略
// BasicLayout輸出所有優(yōu)先級(jí)日志到ConsoleAppender
try {
log4cpp::PropertyConfigurator::configure("./log4cpp.conf");
} catch(log4cpp::ConfigureFailure& f) {
std::cout << "Configure Problem " << f.what() << std::endl;
return -1;
}
// 2 實(shí)例化category對(duì)象
// 這些對(duì)象即使配置文件沒(méi)有定義也可以使用，不過(guò)其屬性繼承其父category
// 通常使用引用可能不太方便，可以使用指針，以后做指針使用
// log4cpp::Category* root = &log4cpp::Category::getRoot();
log4cpp::Category& root = log4cpp::Category::getRoot();
log4cpp::Category& sub1 =
log4cpp::Category::getInstance(std::string("sub1"));
log4cpp::Category& sub3 =
log4cpp::Category::getInstance(std::string("sub1.sub2"));
// 3 正常使用這些category對(duì)象進(jìn)行日志處理。
// sub1 has appender A1 and rootappender.
sub1.info("This is some info");
sub1.alert("A warning");
// sub3 only have A2 appender.
sub3.debug("This debug message will fail to write");
sub3.alert("All hands abandon ship");
sub3.critStream() << "This will show up << as " << 1 << " critical message"
<< log4cpp::CategoryStream::ENDLINE;
sub3 << log4cpp::Priority::ERROR
<< "And this will be an error"
<< log4cpp::CategoryStream::ENDLINE;
sub3.log(log4cpp::Priority::WARN, "This will be a logged warning");
return 0;
}
|
4. 相關(guān)考慮
性能問(wèn)題，可能是很多想使用log4cpp的程序員關(guān)心的問(wèn)題。在參考資料2中有一段描述。結(jié)論就是log4j以及l(fā)og4cpp是以性能為首要目標(biāo)的；如果關(guān)閉日志記錄的話，對(duì)性能影響可以忽略；打開日志記錄，主要消耗是在記錄動(dòng)作，而不是庫(kù)的管理過(guò)程；所以你盡可放心的使用。實(shí)在要深究性能的話。可以從下面方面提高：
輸出的日志消息不要使用復(fù)雜的轉(zhuǎn)換或者處理，比如： sub1.debug(string("Current num is") + i + GetCurStat()); 這種情況即使不進(jìn)行日志處理，括號(hào)中的語(yǔ)句還是會(huì)執(zhí)行。變通方法是：
if(sub1.isDebugEnabled())
{
sub1.debug(string("Current num is") + i + GetCurStat());
}
|
安全性問(wèn)題對(duì)于商業(yè)軟件開發(fā)可能也是問(wèn)題。可能不希望別人通過(guò)修改配置文件獲取程序的調(diào)試等程序內(nèi)部運(yùn)行情況的日志信息。比較穩(wěn)妥的方案或者是加密配置文件，運(yùn)行中解密，輸出到臨時(shí)文件后讀取；或者在發(fā)行版本里讀取配置文件后，強(qiáng)行把低于某個(gè)優(yōu)先級(jí)的category設(shè)到比較高的優(yōu)先級(jí)。
多線程安全性問(wèn)題。當(dāng)前l(fā)og4cpp還沒(méi)有宣稱自己是多線程安全的，不過(guò)其代碼中大多數(shù)可能沖突的地方都增加了線程互斥控制，對(duì)多線程環(huán)境應(yīng)該問(wèn)題不大。但為了加入這個(gè)特性，linux下編譯log4cpp時(shí)，configure請(qǐng)加入--with-pthreads 或者--with-omnithreads選項(xiàng)。Win版本已經(jīng)加入對(duì)MS線程的支持。
5. 參考資料
1. Logging and Tracing in C++ Simplified: Traveling the Road Last Traveled by a Previously Invented Wheel
http://soldc.sun.com/articles/logging.html
2. log4j 提供了對(duì)日志記錄的控制
http://www-900.ibm.com/developerWorks/cn/java/jw-log4j/index.shtml
3. 使用Log4j進(jìn)行日志操作
http://www-900.ibm.com/developerWorks/cn/java/l-log4j/index.shtml
4. log4cpp主頁(yè)
http://sourceforge.net/projects/log4cpp/
5. log4j主頁(yè)
http://jakarta.apache.org/log4j/docs/index.html
6. log4cplus主頁(yè)
http://log4cplus.sourceforge.net/
7. log4c主頁(yè)
http://log4c.sourceforge.net/
6. 關(guān)于作者
李群，關(guān)注于網(wǎng)絡(luò)安全產(chǎn)品的開發(fā)、研究；軟件開發(fā)過(guò)程等方面。您可以通過(guò)liqun@nsfocus.com和他聯(lián)系。
|