log4cplus使用指南
将日志信息写入MySql数据库
先建立一个配置文件log4cplus.properties, 配置连接数据库的参数
log4cplus.rootLogger=INFO, MySQL
log4cplus.appender.MySQL=log4cplus::MySQLAppender
log4cplus.appender.MySQL.host=localhost
log4cplus.appender.MySQL.user=root
log4cplus.appender.MySQL.password=password
log4cplus.appender.MySQL.database=mydatabase
log4cplus.appender.MySQL.table=mytable
log4cplus.appender.MySQL.layout=log4cplus::PatternLayout
log4cplus.appender.MySQL.layout.ConversionPattern=%d{%Y-%m-%d %H:%M:%S.%q} [%t] %-5p %c %%%x%% - %m%n
c++示例代码
#include <log4cplus/logger.h>
#include <log4cplus/loggingmacros.h>
#include <log4cplus/configurator.h>
int main(int argc, char** argv)
{
log4cplus::PropertyConfigurator::doConfigure("log4cplus.properties");
log4cplus::Logger logger = log4cplus::Logger::getRoot();
LOG4CPLUS_INFO(logger, "Hello, log4cplus!");
return 0;
}
将日志信息写入文件,并指定文件大小为10兆,文件个数为10个
#include <log4cplus/logger.h>
#include <log4cplus/loggingmacros.h>
#include <log4cplus/fileappender.h>
#include <log4cplus/layout.h>
#include <log4cplus/helpers/loglog.h>
#include <log4cplus/configurator.h>
int main()
{
// 设置日志文件名
std::string logFileName = "example.log";
// 创建文件附加器
log4cplus::SharedAppenderPtr fileAppender(new log4cplus::RollingFileAppender(
logFileName, 10 * 1024 * 1024, 10));
// 设置文件附加器的布局
log4cplus::SharedObjectPtr<log4cplus::Layout> layout(new log4cplus::TTCCLayout());
fileAppender->setLayout(layout);
// 创建日志器
log4cplus::Logger logger = log4cplus::Logger::getInstance("example");
// 添加文件附加器到日志器
logger.addAppender(fileAppender);
// 记录日志信息
LOG4CPLUS_INFO(logger, "Hello, log4cplus!");
return 0;
}
控制日志输出等级
#include <log4cplus/logger.h>
#include <log4cplus/loggingmacros.h>
#include <log4cplus/fileappender.h>
#include <log4cplus/layout.h>
#include <log4cplus/helpers/loglog.h>
#include <log4cplus/configurator.h>
int main()
{
// 创建文件附加器
log4cplus::SharedAppenderPtr fileAppender(new log4cplus::RollingFileAppender(
"example.log", 10 * 1024 * 1024, 10));
// 设置文件附加器的布局
log4cplus::SharedObjectPtr<log4cplus::Layout> layout(new log4cplus::TTCCLayout());
fileAppender->setLayout(layout);
// 创建日志器
log4cplus::Logger logger = log4cplus::Logger::getInstance("example");
// 设置日志器的级别为INFO
logger.setLogLevel(log4cplus::INFO_LOG_LEVEL);
// 添加文件附加器到日志器
logger.addAppender(fileAppender);
// 记录不同级别的日志信息
LOG4CPLUS_DEBUG(logger, "debug message");
LOG4CPLUS_INFO(logger, "info message");
LOG4CPLUS_WARN(logger, "warn message");
LOG4CPLUS_ERROR(logger, "error message");
return 0;
}
在上述代码中,创建了一个Logger对象,命名为example。然后,使用Logger对象的setLogLevel方法,将日志级别设置为INFO。这意味着,Logger对象将忽略所有低于INFO级别的日志信息,只输出INFO级别及以上的信息。
控制日志输出格式
#include <log4cplus/logger.h>
#include <log4cplus/loggingmacros.h>
#include <log4cplus/fileappender.h>
#include <log4cplus/layout.h>
#include <log4cplus/helpers/loglog.h>
#include <log4cplus/configurator.h>
int main()
{
// 创建文件附加器
log4cplus::SharedAppenderPtr fileAppender(new log4cplus::RollingFileAppender(
"example.log", 10 * 1024 * 1024, 10));
// 创建自定义布局
log4cplus::SharedObjectPtr<log4cplus::Layout> layout(new log4cplus::PatternLayout("%d{%Y-%m-%d %H:%M:%S.%q} [%t] %-5p %c %%%x%% - %m%n"));
fileAppender->setLayout(layout);
// 创建日志器
log4cplus::Logger logger = log4cplus::Logger::getInstance("example");
// 添加文件附加器到日志器
logger.addAppender(fileAppender);
// 记录日志信息
LOG4CPLUS_INFO(logger, "info message");
return 0;
}
实现日志文件按照日期滚动
#include <log4cplus/logger.h>
#include <log4cplus/loggingmacros.h>
#include <log4cplus/dailyfileappender.h>
#include <log4cplus/layout.h>
#include <log4cplus/configurator.h>
int main()
{
// 初始化log4cplus
log4cplus::initialize();
// 创建按日滚动的文件附加器,保留3天日志
log4cplus::SharedAppenderPtr fileAppender(new log4cplus::DailyRollingFileAppender(
"example.log", log4cplus::DAILY, 3, true));
// 创建自定义布局
std::shared_ptr<log4cplus::Layout> layout(new log4cplus::PatternLayout("%d{%Y-%m-%d %H:%M:%S.%q} [%t] %-5p %c %%%x%% - %m%n"));
fileAppender->setLayout(layout);
// 创建日志器
log4cplus::Logger logger = log4cplus::Logger::getInstance("example");
logger.setLogLevel(log4cplus::INFO_LOG_LEVEL); // 设置日志输出级别
// 添加文件附加器到日志器
logger.addAppender(fileAppender);
// 记录日志信息
LOG4CPLUS_INFO(logger, "info message");
// 关闭log4cplus
log4cplus::Logger::shutdown();
return 0;
}
在DailyRollingFileAppender的构造函数中,第二个参数DAILY表示按日滚动,第三个参数3表示保留3天日志,第四个参数true表示在滚动时是否先关闭当前日志文件。这样配置后,每天会生成一个新的日志文件,同时会删除保留天数之前的日志文件。
将日志发送到日志服务器
#include <log4cplus/log4cplus.h>
int main()
{
//用Initializer类进行初始化
log4cplus::Initializer initializer;
//第1步:创建SocketAppender
log4cplus::SharedAppenderPtr appender(new log4cplus::SocketAppender(
LOG4CPLUS_TEXT("localhost"),
32015, LOG4CPLUS_TEXT("test")));
//第2步:设置Appender的名称,SocketAppender不需要设置输出格式
appender->setName(LOG4CPLUS_TEXT("logserver"));
//第3步:获得一个Logger实例,并设置其日志输出等级阈值
log4cplus::Logger logger = log4cplus::Logger::getInstance(LOG4CPLUS_TEXT ("test"));
logger.setLogLevel(log4cplus::INFO_LOG_LEVEL);
//第4步:为Logger实例添加Appender
logger.addAppender(appender);
//第5步:使用宏将日志输出
LOG4CPLUS_INFO(logger, LOG4CPLUS_TEXT("Hello world"));
return 0;
}
结果可以通过搭建一个日志服务器来查看,服务器的示例可以参考:simpleserver目录下的loggingserver.cxx
配置文件定义
# 配置日志器和附加器
log4cplus.rootLogger=DEBUG, CONSOLE, FILE
# 控制台输出附加器的配置
log4cplus.appender.CONSOLE=log4cplus::ConsoleAppender
log4cplus.appender.CONSOLE.layout=log4cplus::PatternLayout
log4cplus.appender.CONSOLE.layout.ConversionPattern=%d{
%Y-%m-%d %H:%M:%S.%q} [%t] %-5p %c %%%x%% - %m%n
# 文件输出附加器的配置
log4cplus.appender.FILE=log4cplus::RollingFileAppender
log4cplus.appender.FILE.File=example.log
log4cplus.appender.FILE.MaxFileSize=10MB
log4cplus.appender.FILE.MaxBackupIndex=5
log4cplus.appender.FILE.layout=log4cplus::PatternLayout
log4cplus.appender.FILE.layout.ConversionPattern=%d{
%Y-%m-%d %H:%M:%S.%q} [%t] %-5p %c %%%x%% - %m%n
log4cplus.rootLogger=DEBUG, CONSOLE, FILE:定义了根日志器的配置,其中DEBUG表示日志输出级别为DEBUG,CONSOLE和FILE表示附加器的名称。
log4cplus.appender.CONSOLE=log4cplus::ConsoleAppender:定义了一个名为CONSOLE的控制台输出附加器,使用了ConsoleAppender的类。
log4cplus.appender.CONSOLE.layout=log4cplus::PatternLayout:定义了CONSOLE附加器的布局格式,使用了PatternLayout的类。
log4cplus.appender.CONSOLE.layout.ConversionPattern=%d{%Y-%m-%d %H:%M:%S.%q} [%t] %-5p %c %%%x%% - %m%n:定义了CONSOLE附加器的日志输出格式,其中%d表示日期,%q表示毫秒,%t表示线程名,%p表示日志级别,%c表示日志类别,%%x%%表示MDC,%m表示日志信息,%n表示换行符。
log4cplus.appender.FILE=log4cplus::RollingFileAppender:定义了一个名为FILE的文件输出附加器,使用了RollingFileAppender的类。
log4cplus.appender.FILE.File=example.log:定义了输出日志的文件名为example.log。
log4cplus.appender.FILE.MaxFileSize=10MB:定义了每个日志文件的最大大小为10MB。
log4cplus.appender.FILE.MaxBackupIndex=5:定义了最多保留的日志文件数量为5。
log4cplus.appender.FILE.layout=log4cplus::PatternLayout:定义了FILE附加器的布局格式,使用了PatternLayout的类。
编译
windows下
mkdir build
cd build
cmake -A x64 …
其中-A x64参数用来设置编译64位的库。之后在build目录会生成一个VS工程项目,打开log4cplus.sln,在解决方案一栏中右击install选择生成,即可编译成功。库文件会存放在./build/installed/bin中
参考连接
https://blog.csdn.net/lx_shudong/article/details/48732999
5.2.1. 转换标识符
PatterLayout支持的转换标识符主要包括:
(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"等等
TTCCLayout
是在PatternLayout基础上发展的一种缺省的带格式输出的布局器,其格式由时间,线程ID,Logger和NDC 组成(consists of time, thread, Logger and nested diagnostic context information, hence the name),因而得名, 关于NDC请参见6.4小节。
以下代码片段演示了如何使用TTCCLayout。
…
/step1:Instantiateanappenderobject/
SharedObjectPtr_append(new ConsoleAppender());
_append->setName(“appendfortest”);
/step2:Instantiatealayoutobject/
std::auto_ptr_layout(new TTCCLayout());
/step3:Attachthelayoutobjecttotheappender/
_append->setLayout(_layout);
/step4:Instantiatealoggerobject/
Logger_logger=Logger::getInstance(“test_logger”);
/step5:Attachtheappenderobjecttothelogger/
_logger.addAppender(_append);
/logactivity/
LOG4CPLUS_DEBUG(_logger,“teststr”)
…
输出结果:
10-16-04 19:08:27,501 [1075298944] DEBUG test_logger <> - teststr
TTCCLayout在构造时,有机会选择显示本地时间或GMT时间,缺省是按照本地时间显示:TTCCLayout::TTCCLayout(bool use_gmtime = false)。
如果需要构造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
6. 输出重定向(appender)
6.1. 重定向到控制台
log4cplus默认将输出到控制台,提供ConsoleAppender用于操作。示例代码请参见4.2.1、4.2.2或4.2.3小节,这里不再赘述。
6.2. 重定向到文件
log4cplus提供了三个类用于文件操作,它们是FileAppender类、RollingFileAppender类、DailyRollingFileAppender类。
6.2.1. FileAppender
实现了基本的文件操作功能,构造函数如下:
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类的使用情况请参考4.2.5小节,这里不再赘述。
6.2.2. RollingFileAppender
实现可以滚动转储的文件操作功能,构造函数如下:
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 < LOOP_COUNT; ++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。
6.2.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 < LOOP_COUNT; ++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这样的文件。
需要指出的是这里的"频度"并不是你写入文件的速度,其实是否转储的标准并不依赖你写入文件的速度,而是依赖于写入的那一时刻是否满足了频度条件,即是否超过了以分钟、小时、周、月为单位的时间刻度,如果超过了就另存。
6.3. 重定向到远程服务器
log4cplus提供了SocketAppender,实现了C/S方式的日志记录,用于支持重定向到远程服务器。
6.3.1. 客户端程序需要做的工作
(1) 定义一个SocketAppender类型的挂接器
SharedAppenderPtr _append(new SocketAppender(host, 8888, “ServerName”));
(2) 把该挂接器加入到logger中
Logger::getRoot().addAppender(_append);
(3) SocketAppender类型不需要Layout, 直接调用宏就可以将信息发往loggerServer了LOG4CPLUS_INFO(Logger::getRoot(), "This is a test: ")
注意这里对宏的调用其实是调用了SocketAppender::append(),里面有一个数据传输约定,即先发送一个后续数据的总长度,然后再发送实际的数据:
… …
SocketBuffer buffer = convertToBuffer(event, serverName);
SocketBuffer msgBuffer(LOG4CPLUS_MAX_MESSAGE_SIZE);
msgBuffer.appendSize_t(buffer.getSize());
msgBuffer.appendBuffer(buffer);
… …
6.3.2. 服务器端程序需要做的工作
(1) 定义一个ServerSocket
ServerSocket serverSocket(port);
(2) 调用accept函数创建一个新的socket与客户端连接
Socket sock = serverSocket.accept();
(3) 此后即可用该sock进行数据read/write了,形如(完整代码见6.3.3小节):
SocketBuffer msgSizeBuffer(sizeof(unsigned int));
if(!clientsock.read(msgSizeBuffer)){
return;
}
unsigned int msgSize = msgSizeBuffer.readInt();
SocketBuffer buffer(msgSize);
if(!clientsock.read(buffer)){
return;
}
(4) 为了将读到的数据正常显示出来,需要将SocketBuffer存放的内容转换成InternalLoggingEvent格式:
log4cplus::spi::InternalLoggingEvent event = readFromBuffer(buffer);
然后输出:
Logger logger = Logger::getInstance(event.getLoggerName());
logger.callAppenders(event);
注意read/write是按照阻塞方式实现的,意味着对其调用直到满足了所接收或发送的个数才返回。
例6-重定向到远程服务器
以下是服务器端代码。
#include <log4cplus/config.h>
#include <log4cplus/configurator.h>
#include <log4cplus/consoleappender.h>
#include <log4cplus/socketappender.h>
#include <log4cplus/helpers/loglog.h>
#include <log4cplus/helpers/socket.h>
#include <log4cplus/helpers/threads.h>
#include <log4cplus/spi/loggerimpl.h>
#include <log4cplus/spi/loggingevent.h>
#include <iostream>
using namespace std;
using namespace log4cplus;
using namespace log4cplus::helpers;
using namespace log4cplus::thread;
namespace loggingserver
{
class ClientThread : public AbstractThread
{
public:
ClientThread(Socket clientsock) : clientsock(clientsock) {
cout << "Received a client connection!!!!" << endl;
}
~ClientThread() {
cout << "Client connection closed." << endl;
}
virtual void run();
private:
Socket clientsock;
};
}
int main(int argc, char** argv)
{
if (argc < 3) {
cout << "Usage: port config_file" << endl;
return 1;
}
int port = atoi(argv[1]);
tstring configFile = LOG4CPLUS_C_STR_TO_TSTRING(argv[2]);
PropertyConfigurator config(configFile);
config.configure();
ServerSocket serverSocket(port);
while (1) {
loggingserver::ClientThread* thr = new loggingserver::ClientThread(serverSocket.accept());
thr->start();
}
return 0;
}
//
// loggingserver::ClientThread implementation
//
void loggingserver::ClientThread::run()
{
while (1) {
if (!clientsock.isOpen()) {
return;
}
SocketBuffer msgSizeBuffer(sizeof(unsigned int));
if (!clientsock.read(msgSizeBuffer)) {
return;
}
unsigned int msgSize = msgSizeBuffer.readInt();
SocketBuffer buffer(msgSize);
if (!clientsock.read(buffer)) {
return;
}
spi::InternalLoggingEvent event = readFromBuffer(buffer);
Logger logger = Logger::getInstance(event.getLoggerName());
logger.callAppenders(event);
}
}
以下是客户端代码。
#include <log4cplus/logger.h>
#include <log4cplus/socketappender.h>
#include <log4cplus/loglevel.h>
#include <log4cplus/tstring.h>
#include