暂无图片
暂无图片
暂无图片
暂无图片
暂无图片

Log4j.properties的配置详解

阿胡的技术日志 2020-05-10
457

先上个模板:



Log4j有三个主要的组件:Loggers(记录器)、Appenders(输出目的地)、Layouts(布局)。

1.Loggers(记录器):记录日志信息的类型和级别。

在Log4j中其分为五个级别,用来指定日志信息的重要程度,分别是(级别由低到高排序):DEBUG(调试信息)、INFO(普通信息)、WARN(警告)、ERROR(错误)、FATAL(致命错误)。

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

1.1 配置根Logger语法:
log4j.rootLogger = [ level ] , appenderName1 , appenderName2,...
log4j.additivity.org.apache=false

1.2 详解:
[level]:设定日志信息的最低级别,课设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或自定义级别。Log4j建议只使用四个级别,即ERROR、WARN、INFO、DEBUG。

appenderName:指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开即可。

第二句表示Logger不会在父Logger的appender里输出,默认为true。

1.3模板举例:
log4j.rootCategory=debug,CONSOLE

注:rootCategory和rootLogger区别:rootCategory是旧的使用名称,对应原来的Category类;rootLagger是新的使用名称,对应Logger类,Logger类是Category类的子类。二者在使用上没有多大区别,不过不推荐使用rootCategory。

2.Appenders(输出目的地):记录日志要输出的地方。

Log4j允许把日志输出到不同的地方,如控制台(Console)、文件(Files)等。也可以根据天数或文件大小产生新的文件,或以流的形式发送到其他地方。

2.1 配置日志信息输出目的地语法:
log4j.appender.appenderName=className
log4j.appender.appenderName.layout.Option1=value1
...
log4j.appender.appenderName.layout.OptionN=valueN

2.2 详解:
appenderName:自定义appenderName,在log4j.rootLogger设置中使用。

className:类名。
常使用的类有:
(1)org.apache.log4j.ConsoleAppender(控制台)
(2)org.apache.log4j.FileAppender(文件) (3)org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
(4)org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸后产生一个新的文件)
(5)org.apache.log4j.WritterAppender(将日志信息以流的形式发送到指定位置)

Option:操作。不同选项包含的操作如下:
1)ConsoleAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认值为DEBUG。
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值为true。
Target=System.err:默认值是System.out。

2)FileAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
ImediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认为true。
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。

3)DailyRollingFileAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
ImediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认为true。
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认是true。
File=D:/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:每分钟。

4)RollingFileAppender选项:
Threshold=WARN:指定日治信息的最低输出级别,默认为DEBUG。
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不会输出,默认为true。
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认为true。
File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。
MaxFileSize=100KB:单位可以是KB、MB、GB。表示在日志到达该指定大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。
MaxBackupIndex=2:指定可以产生的滚动文件最大数,。如:设为2时则可以产生logging.log4j.1和logging.log4j.2两个滚动文件和一个logging.log4j文件。

2.3 模板举例:
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=c:\axis.log
log4j.appender.LOGFILE.Append=true

3. Layouts(布局):记录日志以何种形式输出。

log4j可以在Appenders后面附加Layouts,以便用户根据自己喜好,格式化日志输出。

Layouts提供四种日志输出样式:根据HTML样式、自由指定样式、包含日志级别与信息的样式以及包含日志时间、线程、类别等信息的样式。

3.1 配置日志信息的输出格式:
log4j.appender.appenderName.layout=className
log4j.appender.appenderName.layout.Option1=value1
...
log4j.appender.appenderName.layout.OptionN=valueN

3.2 详解:
className:类名。
可设的置有:
(1)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
(2)org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
(3)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
(4)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等信息)

Option:操作。不同选项包含的操作如下:
1)HTMLLayout选项:
LocationInfo=true:输出Java文件名称和行号,默认值是false。
Title=My Logging:默认值是Log4J Log Messages。

2)PatternLayout选项:
ConversionPattern=%m%n:设定以怎样的格式显示消息。


PatternLayout参数说明:


%c:输出日志信息所属的类目,通常就是所在类的全名。如果再加上{<层数>},则表示从内层算起的指定层数的名字空间。例如:当前logger的名字空间是"a.b.c", %c 输出a.b.c;%c{2} 输出b.c。


%C:列出调用logger类的全名,包含包路径。例如:假设当前类是"org.apache.xyz.SomeClass",%C 输出org.apache.xyz.SomeClass;%C{1} 输出SomeClass。


此外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度以及文本对齐方式。如:

%20c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,则左边用空格填充,即表示右对齐。


%-20c: "-"表示左对齐,其余同上一条。


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


%20.30c:如果Category的名称小于20就左补空格,使其右对齐,如果其名称长于30字符,就将左边多出的字符截掉。


%d:输出日志时间点的日期或时间,默认为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。


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


%I:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。如:test.TestLog4j.main(TestLog4j.java:10)。


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


%M:输出产生日志信息的方法名。


%m:输出代码中指定的具体日志信息。


%n:输出一个回车换行符。Windows平台为"\r\n",Unix平台为"\n"。


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


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


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


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


%X:按MDC(线程映射表)输出日志,通常用于多个客户端连接同一台服务器,方便服务器区分是那个客户端访问留下来的日志信息。


%%:输出一个"%"字符。


3.3 模板举例:

log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout

log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n


最后,本文大部分是参考的知乎用户zhangzj,号主只是用自己喜欢的排列顺序重新整理了一遍。附上原链接如下:

Log4j.properties配置详解 - zhangzj的文章 - 知乎
https://zhuanlan.zhihu.com/p/27615369


另外,PatternLayout参数那里真的是搞得我头疼,看了几个博客,内容千篇一律,Emmm,,,大家应该都懂得的,简直比我这个号主还懒。而且这几个博客的参数写的也不甚明细,但是现下号主也只想写到这儿了,等以后遇到便再次更新吧。


文章转载自阿胡的技术日志,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。

评论