Log4J的配置文件(Configuration File)

Posted 2021-04-20 knowalker

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。

配置文件

Log4J配置文件的基本格式如下：

#配置根Logger
log4j.rootLogger=[level],appenderName1,appenderName2,...
#配置日志信息输出目的地Appender
log4j.appender.appenderName=fully.qualified.name.of.appender.class 
log4j.appender.appenderName.option1=value1 
...
log4j.appender.appenderName.optionN=valueN 

#配置日志信息的格式（布局）
log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class 
log4j.appender.appenderName.layout.option1=value1 
...
log4j.appender.appenderName.layout.optionN=valueN

其中 [level] 是日志输出级别，共有5级：

FATAL      0  
ERROR      3  
WARN       4  
INFO       6  
DEBUG      7

Appender 为日志输出目的地，Log4j提供的appender有以下几种：

• org.apache.log4j.ConsoleAppender（控制台），

• org.apache.log4j.FileAppender（文件），

• org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），

• org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），

• org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

Layout：日志输出格式，Log4j提供的layout有以下几种：

• org.apache.log4j.htmlLayout（以HTML表格形式布局），

• org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

• org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

• org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

控制台选项

• Threshold=DEBUG: 指定日志消息的输出最低层次。

• ImmediateFlush=true: 默认值是true,意谓着所有的消息都会被立即输出。

• Target=System.err: 默认情况下是, System.out, 指定输出控制台

FileAppender 选项

• Threshold=DEBUF:指定日志消息的输出最低层次。

• ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

• File=mylog.txt:指定消息输出到mylog.txt文件。

• Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

RollingFileAppender 选项

• Threshold=DEBUG: 指定日志消息的输出最低层次。

• ImmediateFlush=true: 默认值是true,意谓着所有的消息都会被立即输出。

• File=mylog.txt: 指定消息输出到mylog.txt文件。

• Append=false: 默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

• MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。

• MaxBackupIndex=2: 指定可以产生的滚动文件的最大数。

• log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，日志信息格式中几个符号所代表的含义：

• -X号: X信息输出时左对齐；

• %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

• %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

• %r: 输出自应用启动到输出该log信息耗费的毫秒数

• %c: 输出日志信息所属的类目，通常就是所在类的全名

• %t: 输出产生该日志事件的线程名

• %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.java:10)

• %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

• %%: 输出一个”%”字符

• %F: 输出日志消息产生时所在的文件名称

• %L: 输出代码中的行号

• %m: 输出代码中指定的消息,产生的日志具体信息

• %n: 输出一个回车换行符，Windows平台为”/r/n”，Unix平台为”/n”输出日志信息换行

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

• %20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。

• %-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，”-“号指定左对齐。

• %.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。

• %20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉。

配置文件-DEMO

### set log levels ###
log4j.rootLogger = debug,stdout,D,E

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n

### 输出到日志文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 保存异常信息到单独文件 ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = logs/error.log ## 异常日志文件名
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

文件配置Sample

下面给出的Log4J配置文件实现了输出到控制台，文件，回滚文件，发送日志邮件，输出到数据库日志表，自定义标签等全套功能。

log4j.rootLogger=DEBUG,CONSOLE,A1,im 
#DEBUG,CONSOLE,FILE,ROLLING_FILE,MAIL,DATABASE
log4j.addivity.org.apache=true
################### 
# Console Appender 
################### 
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
log4j.appender.Threshold=DEBUG 
log4j.appender.CONSOLE.Target=System.out 
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n
##################### 
# File Appender 
##################### 
log4j.appender.FILE=org.apache.log4j.FileAppender 
log4j.appender.FILE.File=file.log 
log4j.appender.FILE.Append=false 
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout 
log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
# Use this layout for LogFactor 5 analysis
######################## 
# Rolling File 
######################## 
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender 
log4j.appender.ROLLING_FILE.Threshold=ERROR 
log4j.appender.ROLLING_FILE.File=rolling.log 
log4j.appender.ROLLING_FILE.Append=true 
log4j.appender.ROLLING_FILE.MaxFileSize=10KB 
log4j.appender.ROLLING_FILE.MaxBackupIndex=1 
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
#################### 
# Socket Appender 
#################### 
log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender 
log4j.appender.SOCKET.RemoteHost=localhost 
log4j.appender.SOCKET.Port=5001 
log4j.appender.SOCKET.LocationInfo=true 
# Set up for Log Facter 5 
log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout 
log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n
######################## 
# Log Factor 5 Appender 
######################## 
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
######################## 
# SMTP Appender 
####################### 
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 
log4j.appender.MAIL.Threshold=FATAL 
log4j.appender.MAIL.BufferSize=10 
log4j.appender.MAIL.From=[e-mail]
log4j.appender.MAIL.SMTPHost=mail.hollycrm.com 
log4j.appender.MAIL.Subject=Log4J Message 
log4j.appender.MAIL.To=[e-mail]
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout 
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
######################## 
# JDBC Appender 
####################### 
log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender 
log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test 
log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver 
log4j.appender.DATABASE.user=root 
log4j.appender.DATABASE.password= 
log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n') 
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout 
log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.A1.File=SampleMessages.log4j 
log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j' 
log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout
################### 
#自定义Appender 
################### 
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net 
log4j.appender.im.username = username 
log4j.appender.im.password = password 
log4j.appender.im.recipient = [e-mail]
log4j.appender.im.layout=org.apache.log4j.PatternLayout 
log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

高级使用

实验目的：

1. 把FATAL级错误写入2000NT日志

2. WARN，ERROR，FATAL级错误发送email通知管理员

3. 其他级别的错误直接在后台输出

实验步骤：

1. 把Log4j压缩包里的NTEventLogAppender.dll拷到WINNT/SYSTEM32目录下

2. 写配置文件log4j.properties

全部配置文件：log4j.properties

 # 在后台输出
 log4j.logger.console=DEBUG, A1
 # APPENDER A1
 log4j.appender.A1=org.apache.log4j.ConsoleAppender
 log4j.appender.A1.layout=org.apache.log4j.PatternLayout
 log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
# 在2000系统日志输出
 log4j.logger.NTlog=FATAL, A8
 # APPENDER A8
 log4j.appender.A8=org.apache.log4j.nt.NTEventLogAppender
 log4j.appender.A8.Source=JavaTest
 log4j.appender.A8.layout=org.apache.log4j.PatternLayout
 log4j.appender.A8.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
# 将日志发送到email
 log4j.logger.MailLog=WARN,A5
 #  APPENDER A5
 log4j.appender.A5=org.apache.log4j.net.SMTPAppender
 log4j.appender.A5.BufferSize=5
 log4j.appender.A5.To=[e-mail]
 log4j.appender.A5.From=[e-mail]
 log4j.appender.A5.Subject=ErrorLog
 log4j.appender.A5.SMTPHost=smtp.263.net
 log4j.appender.A5.layout=org.apache.log4j.PatternLayout
 log4j.appender.A5.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

全部代码：Log4jTest.java

import org.apache.log4j.*; 
/** * log4j test */  public class Log4jTest{        public static void main(String args[])        {
                PropertyConfigurator.configure("log4j.properties");                //在后台输出
                Logger logger1 = Logger.getLogger("console");
                logger1.debug("debug!!!");
                logger1.info("info!!!");
                logger1.warn("warn!!!");
                logger1.error("error!!!");
                logger1.fatal("fatal!!!");                //在NT系统日志输出
                Logger logger2 = Logger.getLogger("NTlog");                //NTEventLogAppender nla = new NTEventLogAppender();
                logger2.debug("debug!!!");
                logger2.info("info!!!");
                logger2.warn("warn!!!");
                logger2.error("error!!!");                //只有这个错误才会写入2000日志
                logger2.fatal("fatal!!!");                //把日志发送到mail
                Logger logger3 = Logger.getLogger("MailLog");                //SMTPAppender sa = new SMTPAppender();
                logger3.warn("warn!!!");
                logger3.error("error!!!");
                logger3.fatal("fatal!!!");
        }
}