文章目录
基本概念
Logger:日志记录器。负责记录日志,是category的子类。
category:类别。可以设置类下所有的Logger,类似于java中的包,效果与Logger名字等价;
rootLogger:根记录器。是所有记录器的父亲,任何记录器都可继承rooLogger的配置;
Appender:输出地。定义日志该如何输出;
Layout:日志格式。负责以什么格式输出、输出哪些附加信息(比如:时间、类名、方法名、所在行数等)。
在log4j.properties配置中,log4j.logger后面配置的是Logger,log4j.appender后面配置的是Appender,
log4j.appender.*.layout后面配置的是Layout,rootLogger直接用log4j.rootLogger配置。
Appender
常使用的类如下:(+后面的表示可以配置的参数,但一般都有默认值,或者会被其他配置覆盖)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(按照时间产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
Layout
常使用的类如下:
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等信息)
配置
墙裂推荐使用xml方式配置,结构比较清晰,配置方便易懂
Properties 配置解析
配置Logger
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …(默认输出目的地,当前端传入类名)
log4j.additivity.org.apache=false:表示Logger不会在父Logger的appender里输出,默认为true。
level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。
appenderName:就是指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开。
例如:log4j.rootLogger=INFO,A1,B2,C3
配置日志信息输出Appender
log4j.appender.appenderName = className
appenderName:自定义appderName,在log4j.rootLogger设置中使用;
className:可设值如下:
-
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
- Threshold=WARN:指定日志信息的最低输出级别,如:DEBUG。
- ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
-
org.apache.log4j.ConsoleAppender(控制台)
-
Threshold=WARN:指定日志信息的最低输出级别,如:DEBUG。
-
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
-
Target=System.err:默认值是System.out。
log4j.rootLogger=DEBUG,console log4j.additivity.org.apache=false log4j.appender.console=org.apache.log4j.ConsoleAppender log4j.appender.console.Threshold=DEBUG log4j.appender.console.ImmediateFlush=true log4j.appender.console.Target=System.out log4j.appender.console.layout=org.apache.log4j.PatternLayout log4j.appender.console.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n
-
-
org.apache.log4j.FileAppender(文件)
-
Threshold=WARN:指定日志信息的最低输出级别,如:DEBUG。
-
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
-
Append=true:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
-
File=logs/logging.log4j:指定消息输出到logging.log4j文件中。
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=logs/log.log4j log4j.appender.logFile.layout=org.apache.log4j.PatternLayout log4j.appender.logFile.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n log4j.logger.fileLogger=warn,logFile log4j.additivity.fileLogger=false
-
-
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
-
Threshold=WARN:指定日志信息的最低输出级别,如:DEBUG。
-
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
-
Append=true:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
-
File=logs/logging.log4j:指定消息输出到logging.log4j文件中。
-
MaxFileSize=100KB:后缀可以是KB, MB 或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。
-
MaxBackupIndex=2:指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件。
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=logs/log.log4j2 log4j.appender.rollingFile.MaxFileSize=200KB log4j.appender.rollingFile.MaxBackupIndex=50 log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout log4j.appender.rollingFile.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n log4j.logger.fileLogger=warn,rollingFile log4j.additivity.fileLogger=false
-
-
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
-
Threshold=WARN:指定日志信息的最低输出级别,如:DEBUG。
-
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
-
Append=true:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
-
File=logs/logging.log4j:指定消息输出到logging.log4j文件中。
-
DatePattern=’.'yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。
另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
- '.'yyyy-MM:每月
- '.'yyyy-ww:每周
- '.'yyyy-MM-dd:每天
- '.'yyyy-MM-dd-a:每天两次
- '.'yyyy-MM-dd-HH:每小时
- '.'yyyy-MM-dd-HH-mm:每分钟
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender log4j.appender.dailyFile.Threshold=DEBUG log4j.appender.dailyFile.ImmediateFlush=true log4j.appender.dailyFile.Append=true log4j.appender.dailyFile.File=logs/log.log4j3 log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout log4j.appender.dailyFile.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n log4j.logger.fileLogger=warn,dailyFile log4j.additivity.fileLogger=false
-
设置包级别的日志权限
#设置相应包的级别
log4j.logger.org.spring=error
log4j.logger.org.apache.commons.httpclient=off
log4j.logger.org.apache.struts2=info
配置日志信息的输出格式Layout
log4j.appender.appenderName.layout=className
className:可设值如下:
-
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
- LocationInfo=true:输出java文件名称和行号,默认值是false。
- Title=My Logging: 默认值是Log4J Log Messages。
-
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
-
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
- ThreadPrinting=true, 打印线程信息,默认是true
- CategoryPrefixing=true,是否输出类名前缀,默认true
- ContextPrinting=true,时候输出当前线程的上下文,默认true
-
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
-
ConversionPattern=%m%n:设定以怎样的格式显示消息。
格式化符号说明:
%p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。 %d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。 %r:输出自应用程序启动到输出该log信息耗费的毫秒数。 %t:输出产生该日志事件的线程名。 %l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。 %c:输出日志信息所属的类目,通常就是所在类的全名。 %M:输出产生日志信息的方法名。 %F:输出日志消息产生时所在的文件名称。 %L::输出代码中的行号。 %m::输出代码中指定的具体日志信息。 %n:输出一个回车换行符,Windows平台为"rn",Unix平台为"n"。 %x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 %%:输出一个"%"字符。 另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如: 1) c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。 2)%-20c:"-"号表示左对齐。 3)%.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。
-
XML配置
-
控制台输出
<!--输出到控制台--> <appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender"> <!--Threshold是个过滤器,它将把低于所设置的level的信息过滤不显示出来--> <param name="Threshold" value="DEBUG" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n"/> </layout> </appender> <root> <priority value="INFO" /> <appender-ref ref="consoleAppender"/> </root>
-
滚动文件输出
<!-- 系统应用级别日志,日志达到一定大小后,滚动生成新的文件,文件名字后面加下标 --> <appender name="fileMaxAppender" class="org.apache.log4j.RollingFileAppender"> <param name="threshold" value="error" /> <param name="file" value="logs/all.sys.log" /> <param name="maxFileSize" value="10MB" /> <param name="maxBackupIndex" value="5" /> <!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 --> <param name="append" value="true" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n" /> </layout> </appender> <logger name="fileMaxLogger" additivity="false"> <appender-ref ref="fileMaxAppender"/> <level value="info"/> </logger>
-
按照日期滚动的生成日志文件(推荐)
<!--输出到文件 所有日志,根据name='DatePattern'设置每隔多久分割成一个新文件 --> <appender name="fileAppender" class="org.apache.log4j.DailyRollingFileAppender"> <param name="File" value="logs/all.log" /> <!-- value的格式,(天,小时,分钟), 控制每隔多久分割成一个新文件 --> <param name="DatePattern" value=".yyyy-MM-dd-HH" /> <!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 --> <param name="append" value="true" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss}] {%p} %c %L - %m%n" /> </layout> <!-- 日志级别,必须LevelMin <= LevelMax ,否则不输出日志 --> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="LevelMin" value="WARN" /> <param name="LevelMax" value="ERROR" /> </filter> </appender> <logger name="fileLogger" additivity="false"> <appender-ref ref="fileAppender"/> <level value="info"/> </logger>
-
其它类型日志
<!-- HTML形式的错误日志,<layout>标签中使用org.apache.log4j.HTMLLayout --> <appender name="fileHTMLAppender" class="org.apache.log4j.RollingFileAppender"> <param name="threshold" value="error" /> <param name="file" value="logs/all.log.html" /> <param name="maxFileSize" value="10MB" /> <param name="maxBackupIndex" value="5" /> <param name="append" value="true" /> <layout class="org.apache.log4j.HTMLLayout" /> </appender> <!-- XML形式错误日志 <layout>标签中使用org.apache.log4j.xml.XMLLayout --> <appender name="fileXMLAppender" class="org.apache.log4j.RollingFileAppender"> <param name="threshold" value="error" /> <param name="file" value="logs/all.log.xml" /> <param name="maxFileSize" value="10MB" /> <param name="maxBackupIndex" value="5" /> <param name="append" value="true" /> <layout class="org.apache.log4j.xml.XMLLayout" /> </appender> <!-- 邮件日志,添加发送和接收日志的邮箱地址 --> <appender name="mailMAILAppender" class="org.apache.log4j.net.SMTPAppender"> <param name="threshold" value="debug" /> <param name="BufferSize" value="10" /> <param name="From" value="xxx@163.com" /> <param name="SMTPHost" value="www.baidu.com" /> <param name="Subject" value="xxx-log4j-Message" /> <param name="To" value="xxx@163.com" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%-5p][%d{yyyy-MM-dd HH:mm:ss,SSS}][%c] :%m%n" /> </layout> </appender> <!-- SOCKET日志 --> <appender name="remoteSocketAppender" class="org.apache.log4j.net.SocketAppender"> <param name="threshold" value="fatal" /> <param name="remoteHost" value="localhost" /> <param name="port" value="1012" /> <param name="locationInfo" value="true" /> </appender>
注意
- root中的priority|level 和logger中的level 都会覆盖掉,appender中的threshold
- root会收集所有的日志输出,包括在root中ref的,和在logger中定义的,如果不想把自定义的logger中的日志额外输出,请设置additivity=“false”
- 定义的appender生效有两种方式,root中ref一个定义好的appender,logger引用一个定义好的appener
- 可以不要root标签,定义单独的logger,但是不建议这么做。如果你所有的日志都输出到一个文件中,就不需要定义logger,用root引用你具体filleAppender即可。
- 使用了getLogger(“xxx”),那么在日志中就会输出xxx,不会输出具体的类名了
- appender中定义的filter,优先级比logger和root中level高。
- Logger 配置的时候使用包的名称,在使用类中用类名getLogger,就可以避免自定义logger名称导致的输出不了类名的问题。
- logger中的名称无论是自定义的还是用类名的,都是去logger中匹配的,没有的就走root,没有root的就无法输出匹配不上的日志。没有ref的logger也是走root。