转自:http://www.cnblogs.com/james1207/p/3328996.html
简介
log4cplus是log4j的c++移植版,是c++中一个很好的打印日志的库。它与另外一个c++的log库log4cxx相比较,好处是不依赖于libapr和libaprutil,可以静态链接到程序中,便于部署。
安装
tar xvzf log4cplus-x.x.x.tar.gz
cd log4cplus-x.x.x
./configure --prefix=/where/to/install
make
make install
这里我采用缺省安装路径:/usr/local
头文件在/usr/local/include/log4cplus目录下,使用的时候需要连接动态库或静态库均可,/usr/local/lib/liblog4cplus.a(静态库)或 log4cplus(动态库)。
配置说明
文件:log.properties
log4cplus.rootLogger=ERROR, R
log4cplus.appender.R=log4cplus::DailyRollingFileAppender
log4cplus.appender.R.File=./log/error.log
log4cplus.appender.R.Schedule=HOURLY
log4cplus.appender.R.Append=true
log4cplus.appender.R.layout=log4cplus::PatternLayout
log4cplus.appender.R.layout.ConversionPattern=[%D{%Y-%m-%d %H:%M:%S,%Q}] [%t] %-5p - %m%n
log4cplus提供一个类【PropertyConfigurator】来实现从文件读取配置,参数就是文件名。其他参数采用默认。
配置文件内容如下:
1. 选择logger
Logger logger = Logger::getRoot(); 这个用来选择rootLogger的
其他的还可以配置更多的logger,Logger logger = log4cplus::Logger::getInstance("test");
一般情况下不是很需要。
2. 日志输出级别 TRACE
logger名称之后的第一个参数可以控制日志输出,如在debug环境中,输出各种debug信息,而在线上环境中,则只需要输出info和各类错误信息。log4cplus支持如下日志级别,使用方法可以看cpp代码。
•TRACE •DEBUG •INFO •WARN •ERROR •FATAL
上述各种级别中,从上往下,重要性依次递增。而在配置文件中的级别会屏蔽掉比它重要性更低的日志输出。
3. appender配置
每个logger可以添加appender,在logger后面的第二个参数即为apppender
如这个例子:log4cplus.rootLogger=ERROR, R
名称为R的appender
在appender上可以设置日志输出位置、日志路径、layout等等内容
a. 日志文件名
通过配置项:log4cplus.appender.R.File=./log/error.log
4. appender输出位置
(1)控制台输出
ConsoleAppender
(2)文件输出
FileAppender / RollingFileAppender / DailyRollingFileAppender .
5. layout
layout是控制日志输出格式的
log4cplus.appender.R.layout=log4cplus::PatternLayout
log4cplus.appender.R.layout.ConversionPattern=[%D{%Y-%m-%d%H:%M:%S,%Q}] [%t] %-5p - %m%n
格式包括三种类型:
1.) SimpleLayout 是一种简单格式的布局器,在输出的原始信息之前加上LogLevel和一个"-"。
2.) TTCCLayout 其格式由时间,线程ID,Logger和NDC 组成。
3.) PatternLayout 是一种有词法分析功能的模式布局器,类似正则表达式。以“%”作为开头的特殊预定义标识符,将产生特殊的格式信息。
在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",输出当前记录器所在的文件名称,比如"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.appender.R.layout.ConversionPattern=[%D{%Y-%m-%d%H:%M:%S,%Q}] [%t] %-5p - %m%n
实例
配置log.properties
log4cplus.rootLogger=ERROR, R
log4cplus.appender.R=log4cplus::DailyRollingFileAppender
log4cplus.appender.R.File=./log/error.log
log4cplus.appender.R.Schedule=HOURLY
log4cplus.appender.R.Append=true
log4cplus.appender.R.layout=log4cplus::PatternLayout
log4cplus.appender.R.layout.ConversionPattern=[%D{%Y-%m-%d %H:%M:%S,%Q}] [%t] %-5p - %m%n[%p]
log4cplus.logger.test=TRACE, RR
log4cplus.appender.RR=log4cplus::DailyRollingFileAppender
log4cplus.appender.RR.File=./log/test.log
log4cplus.appender.RR.MaxBackupIndex=192 #8 * 24
log4cplus.appender.RR.Schedule=HOURLY
log4cplus.appender.RR.Append=true
log4cplus.appender.RR.layout=log4cplus::PatternLayout
log4cplus.appender.RR.layout.ConversionPattern=%p %D{%Y-%m-%d %H:%M:%S.%q}:%t %F:%L "%m"%n
test.cpp
#include <cstdlib>
#include <log4cplus/logger.h>
#include <log4cplus/configurator.h>
#include <log4cplus/helpers/loglog.h>
#include <log4cplus/helpers/stringhelper.h>
#include <log4cplus/loggingmacros.h> // or else not recognize macro
using namespace std;
using namespace log4cplus;
using namespace log4cplus::helpers;
int main()
{
PropertyConfigurator::doConfigure(LOG4CPLUS_TEXT("log.properties"));
Logger logger = Logger::getRoot();
// trace
LOG4CPLUS_TRACE(logger, "trace and get the fingerprint: " << "random integer: " << random());
// debug
LOG4CPLUS_DEBUG(logger, "this is debug log: " << "random integer: "<< random());
// info
LOG4CPLUS_INFO(logger, "the information centry...." << "[ 1 + 1 = " << 1 + 1 << "]");
// warn
LOG4CPLUS_WARN(logger, "Writing warning messages to log....");
// error
LOG4CPLUS_ERROR(logger, "ooooooh, there is an error....");
//fatal
LOG4CPLUS_FATAL(logger, "oh, my god! the fatal error occur!!!!!!!!!");
//
Logger loggerTest = log4cplus::Logger::getInstance("test");
LOG4CPLUS_TRACE(loggerTest,"anther logger,trace");
LOG4CPLUS_ERROR(loggerTest,"anther logger,error ");
return 0;
}
CC:=g++
CFLAGS:= -g
SRC:= test.cpp
DEST:=client
INCLUDE_PATH:=/usr/local/include
LIB_PATH:=/usr/local/lib
USER_LIBRARIES:=log4cplus
#
H_LIB_PATH := $(foreach n,$(LIB_PATH),-L$(n))
H_USER_LIBRARIES := $(foreach n,$(USER_LIBRARIES),-l$(n))
H_INC_PATH := $(foreach n,$(INCLUDE_PATH),-I$(n))
OBJS:=$(SRC:.cpp=.o)
#
all:tips $(OBJS) $(DEST)
tips:
@echo "begin compile"
$(OBJS):%.o:%.cpp
$(CC) $(CFLAGS) $(H_INC_PATH) -c $? -o $@
$(DEST):$(OBJS)
$(CC) $(CFLAGS) $(H_LIB_PATH) $(H_USER_LIBRARIES) $? -o $@
#
clean:
rm -rf $(DEST) $(OBJS)
在当前目录下:
make,编译出可执行文件client
建一个log目录
./client
你的日志出来了
运行时记得
export LD_LIBRARY_PATH=/usr/local/log4cxx/lib:$LD_LIBRARY_PATH
实战配置
更具体建议参考:/usr/local/include/log4cplus/ fileappender.h
Log.properties中进行日志行为配置:
1.RollingFileAppender
参考:http://www.mamicode.com/info-detail-1777597.html
按文件大小,文件总数限定,循环写日志。这种最实用。
配置中还可以设置哪些登记日志写到文件。
配置如下:
log4cplus.rootLogger=TRACE, ACC
log4cplus.appender.ACC=log4cplus::RollingFileAppender
log4cplus.appender.ACC.File=./log/acc_msgs.log
log4cplus.appender.ACC.MaxFileSize=1MB
log4cplus.appender.ACC.MaxBackupIndex=7
log4cplus.appender.ACC.ImmediateFlush=false
log4cplus.appender.ACC.layout=log4cplus::PatternLayout
log4cplus.appender.ACC.layout.ConversionPattern=%D{%Y-%m-%d %H:%M:%S.%Q}|%-5p|%c[2]|%t|%F:%L|%m%n
log4cplus.appender.ACC.filters.1=log4cplus::spi::LogLevelRangeFilter
log4cplus.appender.ACC.filters.1.LogLevelMin=TRACE
log4cplus.appender.ACC.filters.1.LogLevelMax=FATAL
2.DailyRollingFileAppender
按时间周期产生日志,比如按分钟,小时,天。
官方缺省输出格式缺点明显:无法限制每个文件大小,无法限制个数。因此不实用。
log4cplus.rootLogger=TRACE, R
log4cplus.appender.R=log4cplus::DailyRollingFileAppender
log4cplus.appender.R.File=./log/error.log
log4cplus.appender.R.Schedule=MINUTELY
log4cplus.appender.R.maxBackupIndex = 2
log4cplus.appender.R.layout=log4cplus::PatternLayout
log4cplus.appender.R.layout.ConversionPattern=[%D{%Y-%m-%d %H:%M:%S,%Q}] [%t] %-5p - %m%n[%p]
3.MyDailyRollingFileAppender
自定义按时间周期产生日志,删除过多日志。
参考:https://www.cnblogs.com/rembau/p/5201001.html
重写DailyRollingFileAppender——MyDailyRollingFileAppender
查看DailyRollingFileAppender源代码,发现rollOver()方法是用来生成文件的,当调用subAppend()方法时会根据判断当前时间是否大于应该生成新文件的时间了(具体实现可以查看源码,逻辑还是比较清晰的),如果大于,就生成。首先把当前日志重命名,命名格式为test.log.yyyy-MM-dd-HH-mm,然后重新建test.log文件。看到这里我们就可以想,在rollOver()方法里面加上删除过多的日志就不行了吗,的确可以这么做:
1 package org.apache.log4j;
2
3 import org.slf4j.Logger;
4 import org.slf4j.LoggerFactory;
5
6 import java.io.File;
7 import java.io.FileFilter;
8 import java.io.IOException;
9 import java.text.ParseException;
10 import java.util.*;
11
12 public class MyDailyRollingFileAppender extends DailyRollingFileAppender {
13 private static Logger logger = LoggerFactory.getLogger(MyDailyRollingFileAppender.class);
14 private int maxFileSize = 60;
15
16
17 void rollOver() throws IOException {
18 super.rollOver();
19
20 logger.debug("保留文件数量" + maxFileSize + ",日志文件名称为:" + fileName);
21 List<File> fileList = getAllLogs();
22 sortFiles(fileList);
23 logger.debug(fileList.toString());
24 deleteOvermuch(fileList);
25 }
26
27 /**
28 * 删除过多的文件
29 * @param fileList 所有日志文件
30 */
31 private void deleteOvermuch(List<File> fileList) {
32 if (fileList.size() > maxFileSize) {
33 for (int i = 0;i < fileList.size() - maxFileSize;i++) {
34 fileList.get(i).delete();
35 logger.debug("删除日志" + fileList.get(i));
36 }
37 }
38 }
39
40 /**
41 * 根据文件名称上的特定格式的时间排序日志文件
42 * @param fileList
43 */
44 private void sortFiles(List<File> fileList) {
45 Collections.sort(fileList, new Comparator<File>() {
46 public int compare(File o1, File o2) {
47 try {
48 if (getDateStr(o1).isEmpty()) {
49 return 1;
50 }
51 Date date1 = sdf.parse(getDateStr(o1));
52
53 if (getDateStr(o2).isEmpty()) {
54 return -1;
55 }
56 Date date2 = sdf.parse(getDateStr(o2));
57
58 if (date1.getTime() > date2.getTime()) {
59 return 1;
60 } else if (date1.getTime() < date2.getTime()) {
61 return -1;
62 }
63 } catch (ParseException e) {
64 logger.error("", e);
65 }
66 return 0;
67 }
68 });
69 }
70
71 private String getDateStr(File file) {
72 if (file == null) {
73 return "null";
74 }
75 return file.getName().replaceAll(new File(fileName).getName(), "");
76 }
77
78 /**
79 * 获取所有日志文件,只有文件名符合DatePattern格式的才为日志文件
80 * @return
81 */
82 private List<File> getAllLogs() {
83 final File file = new File(fileName);
84 File logPath = file.getParentFile();
85 if (logPath == null) {
86 logPath = new File(".");
87 }
88
89 File files[] = logPath.listFiles(new FileFilter() {
90 public boolean accept(File pathname) {
91 try {
92 if (getDateStr(pathname).isEmpty()) {
93 return true;
94 }
95 sdf.parse(getDateStr(pathname));
96 return true;
97 } catch (ParseException e) {
98 logger.error("", e);
99 return false;
100 }
101 }
102 });
103 return Arrays.asList(files);
104 }
105 public int getMaxFileSize() {
106 return maxFileSize;
107 }
108
109 public void setMaxFileSize(int maxFileSize) {
110 this.maxFileSize = maxFileSize;
111 }
112 }
首先,要注意的就是怎么判断日志文件夹中的日志是否是日志还是另外不相关的文件,比如备份的日志、控制台日志等。我使用的方法就是判断sdf.parse(name.replaceAll(file.getName(), ""))是否报异常,如果不报异常就说明这个文件是日志,当然不排除有的文件命名恰好符合这个格式,但是这样的文件在日志文件夹下,我们认为它就是一个日志文件也是合理的。然后我们根据sdf.parse(name.replaceAll(file.getName(), ""))解析出来的Date为所有日志进行升序排序放到一个队列中,再保留这个队列最后maxFileSize个文件的情况下,删除多余的日志文件。
然后,我们注意到我们上面的逻辑中用了maxFileSize这个变量,这个变量在MyDailyRollingFileAppender中,这个变量是怎么赋值的呢?
log4j.appender.logfile=org.apache.log4j.MyDailyRollingFileAppender
log4j.appender.logfile.File=test.log
log4j.appender.logfile.DatePattern='.'yyyy-MM-dd-HH-m
log4j.appender.logfile.MaxFileSize=5
log4j.appender.logfile.Append=false
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern= [%d{yyyy-MM-dd HH\:mm\:ss}]%-5p %c(line\:%L) %x-%m%n
其实Log4j支持这种通用的配置方法,注意上面配置第四行,不用另外添加其他任何代码。