Log4j日志配置与详细解析(log4j.properties)

龚迪
2023-12-01

Log4j日志配置详解

1.log4j日志级别

  • DEBUG:输出调试信息;指出细粒度信息事件对调试应用程序是非常有帮助的。 
  • INFO: 输出提示信息;消息在粗粒度级别上突出强调应用程序的运行过程。 
  • WARN: 输出警告信息;表明会出现潜在错误的情形。 
  • ERROR:输出错误信息;指出虽然发生错误事件,但仍然不影响系统的继续运行。 
  • FATAL: 输出致命错误;指出每个严重的错误事件将会导致应用程序的退出。 
  • ALL level:打开所有日志记录开关;是最低等级的,用于打开所有日志记录。 
  • OFF level:关闭所有日志记录开关;是最高等级的,用于关闭所有日志记录。

按照范围从小到大排序:OFF level > FATAL > ERROR > WARN > INFO > DEBUG > ALL level;范围大的会包含范围小的,例如日志设置为INFO级别的话则FATAL、ERROR、WARN、INFO的日志开关都是打开的,而DEBUG的日志开关将是关闭的。

Log4j建议只使用四个级别,优先级从高到低分别是 ERROR、WARN、INFO、DEBUG

Log4j规则:只输出级别不低于设定级别的日志信息,假如Loggers级别设定为INFO,则INFO、WARN、ERROR和FATAL级别的日志信息都会输出,而级别比INFO低的DEBUG则不会输出。

2.Log4j组件

  • Loggers(记录器)
  • Appenders(输出源)
  • Layouts(布局)

2.1.配置根Logger

格式:

log4j.rootLogger = [LEVEL], appenderName1, appenderName2,...
log3j.additivity.org.apache=false #表示Logger不会在父Logger的appender里输出,默认为true

说明:
- LEVEL: 设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义组别,Log4j建议只使用中间四个级别。
- appenderName:指定日志信息要输出到哪里,可以同时指定多个输出目的地,用逗号隔开;

例如:log4j.rootLogger=INFO,stdout, info, warn, error

2.2Appenders(输出源)


禁用和使用日志请求是Log4j的基本功能,Log4j日志系统提供许多强大的功能,比如允许把日志输出到不同的地方,如控制台(Console)、文件(Files)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等。

常用的类如下:
- org.apache.log4j.ConsoleAppender #控制台
- org.apache.log4j.FileAppender #日志文件
- org.apache.log4j.DailyRollingFileAppender #每天产生一个日志文件
- org.apache.log4j.RollingFileAppender #文件大小到达指定尺寸的时候产生一个新的文件
- org.apache.log4j.WriterAppender #将日志信息以流格式发送到任意指定的地方
- org.apache.log4j.jdbc.JDBCAppender #数据库
- org.apache.log4j.net.JMSAppender #
- org.apache.log4j.net.SocketAppender #Socket
- org.apache.log4j.net.SMTPAppender #邮件

2.3Layouts(布局)


有时,用户希望根据自己的喜好格式化自己的日志输出,Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供四种日志输出格式,如根据HTML样式、自由指定样式、包含日志级别与信息的样式、包含日志时间、线程、类别等信息的样式。

常用类如下:
- org.apache.log4j.HTMLLayout #以HTML表格表式布局
- org.apache.log4j.PatternLayout #可以灵活批定布局模式
- org.apache.log4j.SimpleLayout #包含日志信息的级别和信息字符串
- org.apache.log4j.TTCCLayout #包含日志产生的时间、线程、类别等信息

3.1为不同的Appender设置输出级别

在配置文件中修改Appender的Threshold来实现,例如:

##########Set Log Levels###############
log4j.rootLogger = INFO, console, info, error

######### 输出到控制台 ####################
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = %d{ABSOLUTE}%5p%c{ 1 :%L-%m%n
######### 输出到文件 ####################
log4j.appender.info = org.apache.log4j.DailyRollingFileAppender
log4j.appender.info.File = ./logs/info.log
log4j.appender.info.Append = true
log4j.appender.info.Threshold = INFO ##输出INFO级别以上的日志
log4j.appender.info.layout = org.apache.log4j.PatternLayout
log4j.appender.info.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r]-[%p] %m%n
######### 保存异常信息到单独文件 ####################
log4j.appender.error = org.apache.log4j.DailyRollingFileAppender
log4j.appender.error.File = ./logs/error.log
log4j.appender.error.Append = true
log4j.appender.error.Threshold = ERROR ##只输出ERROR级别及以上的日志
log4j.appender.error.layout = org.apache.log4j.PatternLayout
log4j.appender.error.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r]-[%p] %m%n

3.2配置日志信息输出目的地(appender)


语法 log4j.appender.[appenderName] = [className]

- appenderName:自定义的appenderName,在log4j.rootLogger中设置;
- className: 可设置如下值:
- org.apache.log4j.ConsoleAppender #控制台
- org.apache.log4j.FileAppender #日志文件
- org.apache.log4j.DailyRollingFileAppender #每天产生一个日志文件
- org.apache.log4j.RollingFileAppender #文件大小到达指定尺寸的时候产生一个新的文件
- org.apache.log4j.WriterAppender #将日志信息以流格式发送到任意指定的地方
- org.apache.log4j.jdbc.JDBCAppender #数据库
- org.apache.log4j.net.JMSAppender #
- org.apache.log4j.net.SocketAppender #Socket
- org.apache.log4j.net.SMTPAppender #邮件

ConsoleAppender选项
- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别,默认为DEBUG;
- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出,设为false则不输出,默认为true;
- Target = [System.out|System.err]: 默认为System.out;

FileAppender选项:
- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别,默认为DEBUG;
- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出,设为false则不输出,默认为true;
- Append = [true|false]: true表示消息增加到指定文件中,false则将消息覆盖指定文件内容,默认值为true;
- File = [path/file]:指定消息输出到目录path文件file中;

DailyRollingFileAppender选项:
- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别,默认为DEBUG;
- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出,设为false则不输出,默认为true;
- Append = [true|false]: true表示消息增加到指定文件中,false则将消息覆盖指定文件内容,默认值为true;
- File = [path/file]:指定消息输出到目录path文件file中;
- DataPattern =’.’yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为file,前一个月的日志文件名为file.yyyy-MM,另外,可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
- ‘.’yyyy-MM: 每月
- ‘.’yyyy-ww: 每周
- ‘.’yyyy-MM-dd:每天
- ‘.’yyyy-MM-dd-a: 每天两次
- ‘.’yyyy-MM-dd-HH: 每小时
- ‘.’yyyy-MM-dd-HH-mm:每分钟

RollingFileAppender选项:
- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别,默认为DEBUG;
- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出,设为false则不输出,默认为true;
- Append = [true|false]: true表示消息增加到指定文件中,false则将消息覆盖指定文件内容,默认值为true;
- File = [path/file]:指定消息输出到目录path文件file中;
- MaxFileSize = [num][KB|MB|GB]:在日志文件达到该大小时,将会自动滚动,即将原来的内容移到file.1文件中。
- MaxBackupIndex = [num]: 指定可以产生的滚动文件的最大数,例如,设为2时则可以产生file.1, file.2两个滚动文件和一个file文件;

3.3配置日志信息的输出格式(Layout)


语法:log4j.appender.[appenderName].layout = [className]

说明:
- className可设置如下:
- org.apache.log4j.HTMLLayout #以HTML表格表式布局
- org.apache.log4j.PatternLayout #可以灵活批定布局模式
- org.apache.log4j.SimpleLayout #包含日志信息的级别和信息字符串
- org.apache.log4j.TTCCLayout #包含日志产生的时间、线程、类别等信息

HTMLLayout选项:
- LocationInfo = [true|false]: 输出java文件名称和行号,默认值为false;
- Title = My Logging: 默认值为Log4j Log Messages

PatternLayout选项:
- ConversionPattern = [%m%n]: 设定以怎样的格式显示消息;其中的格式化符号有以下说明:

参数说明例子
%c列出logger名字空间的全称,如果加上{<层数>}表示列出从最内层算起的指定层数的名字空间log4j配置文件参数举例输出显示媒介
假设当前logger名字空间是"a.b.c"
%ca.b.c
%c{2}b.c
%20c(若名字空间长度小于20,则左边用空格填充)
%-20c(若名字空间长度小于20,则右边用空格填充)
%.30c(若名字空间长度超过30,截去多余字符)
%20.30c(若名字空间长度小于20,则左边用空格填充;若名字空间长度超过30,截去多余字符)
%-20.30c(若名字空间长度小于20,则右边用空格填充;若名字空间长度超过30,截去多余字符)
%C列出调用logger的类的全名(包含包路径)假设当前类是"org.apache.xyz.SomeClass"
%Corg.apache.xyz.SomeClass
%C{1}SomeClass
%d显示日志记录时间,{<日期格式>}使用ISO8601定义的日期格式%d{yyyy/MM/dd HH:mm:ss,SSS}2005/10/12 22:23:30,117
%d{ABSOLUTE}22:23:30,117
%d{DATE}12 Oct 2005 22:23:30,117
%d{ISO8601}2005-10-12 22:23:30,117
%F显示调用logger的源文件名%FMyClass.java
%l输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数%lMyClass.main(MyClass.java:129)
%L显示调用logger的代码行%L129
%m显示输出消息%mThis is a message for debug.
%M显示调用logger的方法名%Mmain
%n当前平台下的换行符%nWindows平台下表示rn
UNIX平台下表示n
%p显示该条日志的优先级%pINFO
%r显示从程序启动时到记录该条日志时已经经过的毫秒数%r1215
%t输出产生该日志事件的线程名%tMyClass
%x按NDC(Nested Diagnostic Context,线程堆栈)顺序输出日志假设某程序调用顺序是MyApp调用com.foo.Bar
%c %x - %m%nMyApp - Call com.foo.Bar.
com.foo.Bar - Log in Bar
MyApp - Return to MyApp.
%X按MDC(Mapped Diagnostic Context,线程映射表)输出日志。通常用于多个客户端连接同一台服务器,方便服务器区分是那个客户端访问留下来的日志。%X{5}(记录代号为5的客户端的日志)
%%显示一个百分号%%%

4.经典Log4j配置大全

log4j.rootLogger=INFO,stdout, info, warn, error,jdbc
####################控制台Console打印日志##########################
log4j.logger.stdout=stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Threshold=TRACE
log4j.appender.stdout.Encoding=UTF-8
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=[%-5p] %d(%r) -->[%t] %l: %m %x %n

####################日志文件LogFile##########################
log4j.appender.logFile = org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold = DEBUG
log4j.appender.logFile.ImmediateFlush = true
log4j.appender.logFile.Append = true
log4j.appender.logFile.File = ./log/logfile.log
log4j.appender.logFile.layout = org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n


####################回滚文件RollingFile#####################
log4j.appender.rollingFile = org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold = DEBUG
log4j.appender.rollingFile.ImmediateFlush = true
log4j.appender.rollingFile.Append = true
log4j.appender.rollingFile.File = ./log/rollfile.log
log4j.appender.rollingFile.MaxFileSize = 200KB
log4j.appender.rollingFile.MaxBackupIndex = 50
log4j.appender.rollingFile.layout = org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n


#####################定期日志回滚dailyFile###############
#info信息
log4j.logger.info=info
log4j.appender.info=org.apache.log4j.DailyRollingFileAppender
log4j.appender.info.Threshold=INFO
log4j.appender.info.ImmediateFlush=true
log4j.appender.info.Append=true
log4j.appender.info.File=log/info.log
log4j.appender.info.DatePattern='.'yyyy-MM-dd
log4j.appender.info.layout=org.apache.log4j.PatternLayout
log4j.appender.info.layout.ConversionPattern=%d-[HL] %p %l- %m%n
#错误信息
log4j.logger.error=warn
log4j.appender.error=org.apache.log4j.DailyRollingFileAppender
log4j.appender.error.Threshold=ERROR
log4j.appender.error.ImmediateFlush=true
log4j.appender.error.Append=true
log4j.appender.error.File=log/error.log
log4j.appender.error.DatePattern='.'yyyy-MM-dd
log4j.appender.error.layout=org.apache.log4j.PatternLayout
log4j.appender.error.layout.ConversionPattern=%d-[HL] %p %l %m%n
#警告信息
log4j.logger.warn=warn
log4j.appender.warn=org.apache.log4j.DailyRollingFileAppender
log4j.appender.warn.Threshold=WARN
log4j.appender.warn.ImmediateFlush=true
log4j.appender.warn.Append=true
log4j.appender.warn.File=log/warn.log
log4j.appender.warn.DatePattern='.'yyyy-MM-dd
log4j.appender.warn.layout=org.apache.log4j.PatternLayout
log4j.appender.warn.layout.ConversionPattern=%d-[HL] %p %l- %m%n

###########################JDBC将日志输入到数据库############################
log4j.appender.jdbc = org.apache.log4j.jdbc.JDBCAppender
log4j.appender.jdbc.URL = jdbc:mysql://localhost:3306/logdb
log4j.appender.jdbc.driver = com.mysql.jdbc.Driver
log4j.appender.jdbc.user = root
log4j.appender.jdbc.password = root
log4j.appender.jdbc.sql = INSERT INTO log4j(Message) VALUES ('[%-5p] %d(%r) -->[%t] %l: %m %x %n')
log4j.appender.jdbc.layout = org.apache.log4j.PatternLayout
log4j.appender.jdbc.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n

######################应用于Socket######################
#client
log4j.appender.socket = org.apache.log4j.net.SocketAppender
log4j.appender.socket.RemoteHost = localhost
log4j.appender.socket.Port = 5001
log4j.appender.socket.LocationInfo = true
log4j.appender.socket.ReconnectionDelay = 10000

#server
log4j.rootLogger = DEBUG, socketFile
log4j.appender.socketFile = org.apache.log4j.RollingFileAppender
log4j.appender.socketFile.File = ./log/servercollected.log
log4j.appender.socketFile.MaxFileSize = 200KB
log4j.appender.socketFile.MaxBackupIndex = 50
log4j.appender.socketFile.layout = org.apache.log4j.PatternLayout
log4j.appender.socketFile.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n

#########################mail##########################
log4j.appender.mail = org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold = FATAL
log4j.appender.mail.BufferSize = 10
log4j.appender.mail.From = xxxx@mail.com
log4j.appender.mail.SMTPHost = mail.com
log4j.appender.mail.Subject = Log4j Message
log4j.appender.mail.To = david.tian@live.com
log4j.appender.mail.layout = org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n


#######################自定义Appender###############
log4j.appender.im = com.dvtn.www.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 = corlin@cybercorlin.net
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

 

 类似资料: