一、关于配置文件的名称以及在项目中的存放位置
log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式,2.x版本配置文件后缀名只能为".xml",".json"或者".jsn".
系统选择配置文件的优先级(从先到后)如下:
-
1.classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
-
2.classpath下的名为log4j2-test.xml的文件.
-
3.classpath下名为log4j2.json 或者log4j2.jsn的文件.
-
4.classpath下名为log4j2.xml的文件.
我们一般默认使用log4j2.xml进行命名。如果本地要测试,可以把log4j2-test.xml放到classpath,而正式环境使用log4j2.xml,则在打包部署的时候不要打包log4j2-test.xml即可。
二、java项目中Classpath路径到底指的是哪里?
-
1.src不是classpath,WEB-INF/classes,lib才是classpath,WEB-INF/是资源目录, 客户端不能直接访问。
-
2.WEB-INF/classes目录存放src目录java文件编译之后的class文件,xml、properties等资源配置文件,这是一个定位资源的入口。
-
3.lib和classes同属classpath,两者的访问优先级为: lib>classes。
三、配置文件节点解析
(1).根节点Configuration
Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).
- status: Configuration的属性,用来指定log4j本身的打印日志的级别.
- monitorinterval: Configuration的属性,用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.
(2).Appenders节点
常见的有三种子节点:Console、RollingFile、File.
-
Console节点用来定义输出到控制台的Appender.
-
name:Console的属性,指定Appender的名字.
-
target:Console的属性,SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
-
PatternLayout:Console的子节点,输出格式,不设置默认为:%m%n. File节点用来定义输出到指定位置的文件的Appender.
-
name:File的属性,指定Appender的名字.
-
fileName:File的属性,指定输出日志的目的文件带全路径的文件名.
-
PatternLayout:File的子节点,输出格式,不设置默认为:%m%n.RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.
-
name:RollingFilede的属性,指定Appender的名字.
-
fileName:RollingFilede的属性,指定输出日志的目的文件带全路径的文件名.
-
filePattern:RollingFilede的属性,指定新建日志文件的名称格式.
-
PatternLayout:RollingFilede的子节点,输出格式,不设置默认为:%m%n.
-
DefaultRolloverStrategy:RollingFilede的子节点,用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。
-
Policies:RollingFilede的子节点,指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
-
TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.
-
SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
-
Filters:RollingFilede的子节点,决定日志事件能否被输出。过滤条件有三个值:ACCEPT(接受), DENY(拒绝) or NEUTRAL(中立)(后面具体讲)ACCEP和DENY比较好理解就是接受和拒绝的意思,在使用单个过滤器的时候,一般就是使用这两个值。但是在组合过滤器中,如果用接受ACCEPT的话,日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以,在组合过滤器中,接受使用NEUTRAL(中立),被第一个过滤器接受的日志信息,会继续用后面的过滤器进行过滤,只有符合所有过滤器条件的日志信息,才会被最终写入日志文件。
-
ThresholdFilter:Filters的子节点
-
level:ThresholdFilterde的属性,将被过滤的级别。
-
onMatch:ThresholdFilterde的属性,默认值是NEUTRAL
-
onMismatch:ThresholdFilterde的属性,默认是DENY
(3).Loggers节点,
常见的有两种:Root和Logger.
3.3.1 Root节点
Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出
-
level:Root属性,日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
-
appender-ref:Root的子节点,用来指定该日志输出到哪个Appender,通过ref指定.
<loggers>
<root level="DEBUG">
<appender-ref ref="Console"/>
</root>
</loggers>
3.3.2 Logger节点Logger节点
Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。
-
level:Logger属性,日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
-
name:Logger属性,用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
-
additivity:Logger属性
-
appender-ref:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。
<loggers>
<logger name="druid.sql.Statement" level="debug" additivity="false">
<appender-ref ref="druidSqlRollingFile"/>
</logger>
<logger name="org.springframework" level="OFF"/>
</loggers>
四、日志级别
共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
-
All:最低等级的,用于打开所有日志记录.
-
Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低日志级别不让他输出.
-
Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
-
Info:消息在粗粒度级别上突出强调应用程序的运行过程.
-
Warn:输出警告及warn以下级别的日志.
-
Error:输出错误信息日志.
-
Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
-
OFF:最高等级的,用于关闭所有日志记录.
程序会打印高于或等于所设置级别的日志,设置的日志等级越高,打印出来的日志就越少。
五、实战配置:log4j2.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration status="OFF">
<appenders>
<Console name="Console" target="SYSTEM_OUT">
<!--只接受程序中DEBUG级别的日志进行处理-->
<ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="\[%d{HH:mm:ss.SSS}\] %-5level %class{36} %L %M - %msg%xEx%n"/>
</Console>
<!--处理DEBUG级别的日志,并把该日志放到logs/debug.log文件中-->
<!--打印出DEBUG级别日志,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileDebug" fileName="./logs/debug.log"
filePattern="logs/$${date:yyyy-MM}/debug-%d{yyyy-MM-dd}-%i.log.gz">
<Filters>
<!--只接受DEBUG级别的日志,其余的全部拒绝处理-->
<ThresholdFilter level="DEBUG"/>
<ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL"/>
</Filters>
<!--输出日志的格式-->
<PatternLayout
pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>
<Policies>
<SizeBasedTriggeringPolicy size="500 MB"/>
<TimeBasedTriggeringPolicy/>
</Policies>
</RollingFile>
<!--处理INFO级别的日志,并把该日志放到logs/info.log文件中-->
<RollingFile name="RollingFileInfo" fileName="./logs/info.log"
filePattern="logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz">
<Filters>
<!--只接受INFO级别的日志,其余的全部拒绝处理-->
<ThresholdFilter level="INFO"/>
<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
</Filters>
<PatternLayout
pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>
<Policies>
<SizeBasedTriggeringPolicy size="500 MB"/>
<TimeBasedTriggeringPolicy/>
</Policies>
</RollingFile>
<!--处理WARN级别的日志,并把该日志放到logs/warn.log文件中-->
<RollingFile name="RollingFileWarn" fileName="./logs/warn.log"
filePattern="logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz">
<Filters>
<ThresholdFilter level="WARN"/>
<ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
</Filters>
<PatternLayout
pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>
<Policies>
<SizeBasedTriggeringPolicy size="500 MB"/>
<TimeBasedTriggeringPolicy/>
</Policies>
</RollingFile>
<!--处理error级别的日志,并把该日志放到logs/error.log文件中-->
<RollingFile name="RollingFileError" fileName="./logs/error.log"
filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
<ThresholdFilter level="ERROR"/>
<PatternLayout
pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %class{36} %L %M - %msg%xEx%n"/>
<Policies>
<SizeBasedTriggeringPolicy size="500 MB"/>
<TimeBasedTriggeringPolicy/>
</Policies>
</RollingFile>
<!--druid的日志记录追加器-->
<RollingFile name="druidSqlRollingFile" fileName="./logs/druid-sql.log"
filePattern="logs/$${date:yyyy-MM}/api-%d{yyyy-MM-dd}-%i.log.gz">
<PatternLayout pattern="\[%d{yyyy-MM-dd HH:mm:ss}\] %-5level %L %M - %msg%xEx%n"/>
<Policies>
<SizeBasedTriggeringPolicy size="500 MB"/>
<TimeBasedTriggeringPolicy/>
</Policies>
</RollingFile>
</appenders>
<!-- 然后定义logger,只有定义了logger并引入的appender,appender才会生效 -->
<loggers>
<!--默认的root的logger-->
<root level="DEBUG">
<appender-ref ref="Console"/>
<appender-ref ref="RollingFileInfo"/>
<appender-ref ref="RollingFileWarn"/>
<appender-ref ref="RollingFileError"/>
<appender-ref ref="RollingFileDebug"/>
</root>
<!--额外配置的logger-->
<!--记录druid-sql的记录-->
<logger name="druid.sql.Statement" level="debug" additivity="false">
<appender-ref ref="druidSqlRollingFile"/>
</logger>
<!--log4j2 自带过滤日志-->
<Logger name="org.apache.catalina.startup.DigesterFactory" level="error" />
<Logger name="org.apache.catalina.util.LifecycleBase" level="error" />
<Logger name="org.apache.coyote.http11.Http11NioProtocol" level="warn" />
<logger name="org.apache.sshd.common.util.SecurityUtils" level="warn"/>
<Logger name="org.apache.tomcat.util.net.NioSelectorPool" level="warn" />
<Logger name="org.crsh.plugin" level="warn" />
<logger name="org.crsh.ssh" level="warn"/>
<Logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="error" />
<Logger name="org.hibernate.validator.internal.util.Version" level="warn" />
<logger name="org.springframework.boot.actuate.autoconfigure.CrshAutoConfiguration" level="warn"/>
<logger name="org.springframework.boot.actuate.endpoint.jmx" level="warn"/>
<logger name="org.thymeleaf" level="warn"/>
</loggers>
</configuration>
六、Springboot 依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
七、测试代码:
package com.log4j2;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
public class test {
static Logger logger = LogManager.getLogger(test.class.getName());
public static boolean hello(){
logger.trace("entry"); //等同于logger.entry();但此方法在新版本好像已经废弃
logger.error("Did it again!");
logger.info("这是info级信息");
logger.debug("这是debug级信息");
logger.warn("这是warn级信息");
logger.fatal("严重错误");
logger.trace("exit");
return false;
}
public static void main(String\[\] args) {
logger.trace("开始主程序");
for(int i = 0; i < 10000; i++){
logger.info("当前i:"+i);
if(!test.hello()){
logger.error("hello");
}
}
logger.trace("退出程序");
}
}
八、log4j2.xml文件结构
<?xml version="1.0" encoding="UTF-8"?>;
<Configuration>
<Properties>
<Property name="name1">value</property>
<Property name="name2" value="value2"/>
</Properties>
<Filter type="type" ... />
<Appenders>
<Appender type="type" name="name">
<Filter type="type" ... />
</Appender>
...
</Appenders>
<Loggers>
<Logger name="name1">
<Filter type="type" ... />
</Logger>
...
<Root level="level">
<AppenderRef ref="name"/>
</Root>
</Loggers>
</Configuration>
九、Filters
9.1 Filters决定日志事件能否被输出。
过滤条件有三个值:ACCEPT(接受), DENY(拒绝) or NEUTRAL(中立).
ACCEP和DENY比较好理解就是接受和拒绝的意思,在使用单个过滤器的时候,一般就是使用这两个值。但是在组合过滤器中,如果用接受ACCEPT的话,日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以,在组合过滤器中,接受使用NEUTRAL(中立),被第一个过滤器接受的日志信息,会继续用后面的过滤器进行过滤,只有符合所有过滤器条件的日志信息,才会被最终写入日志文件。
9.2 ThresholdFilter
有3个参数:
- level:将被过滤的级别。
- onMatch:默认值是NEUTRAL
- onMismatch:默认是DENY
如果LogEvent 中的 Log Level 大于 ThresholdFilter 中配置的 Log Level,那么返回 onMatch 的值, 否则返回 onMismatch 的值,例如 : 如果ThresholdFilter 配置的 Log Level 是 ERROR , LogEvent 的Log Level 是 DEBUG。 那么 onMismatch 的值将被返回, 因为 ERROR 小于DEBUG。如果是Accept,将自己被接受,而不经过下一个过滤器
9.3 例子
例子可以这样理解:如果是INFO级别及其以上,将经过通过第一个过滤,进入第二个,否则是onMismatch:拒绝进入。对于第二个,如果是大于等于WARN(WARN/ERROR/ERROR),那么将返回onMatch,也就是拒绝,如果是其他情况(也就是INFO),将是中立情况,因为后面没有其他过滤器,则被接受。最后的结果就只剩下INFO级别的日志。也就符合了RollingFileInfo只记录Info级别的规则。
<RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log" filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<Filters>
<ThresholdFilter level="INFO"/>
<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
</Filters>
<PatternLayout pattern="\[%d{HH:mm:ss:SSS}\] \[%p\] - %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="24" modulate="true"/>
<SizeBasedTriggeringPolicy size="50 MB"/>
</Policies>
<DefaultRolloverStrategy max="20"/>
</RollingFile>
十、Lookups
Lookups提供另外一种方式添加某些特殊的值到日志中。
10.1 Date Lookup
与其他lookup不同,它不是通过key去查找值,而是通过SimpleDateFormat验证格式是否有效,然后记录当前时间
<RollingFile name="Rolling-${map:type}" fileName="${filename}" filePattern="target/rolling1/test1-$${date:MM-dd-yyyy}.%i.log.gz">
<PatternLayout>
<pattern>%d %p %c{1.} \[%t\] %m%n</pattern>
</PatternLayout>
<SizeBasedTriggeringPolicy size="500" />
</RollingFile>
10.2 Context Map Lookup: 如记录loginId
<File name="Application" fileName="application.log">
<PatternLayout>
<pattern>%d %p %c{1.} \[%t\] $${ctx:loginId} %m%n</pattern>
</PatternLayout>
</File>
这个的结果和前面的MDC是一样的,即 %X{loginId}
10.3 Environment Lookup:记录系统环境变量
比如可以获取如/etc/profile中的变量值
<File name="Application" fileName="application.log">
<PatternLayout>
<pattern>%d %p %c{1.} \[%t\] $${env:USER} %m%n</pattern>
</PatternLayout>
</File>
10.4 System Properties Lookup
可以获取Java中的系统属性值。
<Appenders>
<File name="ApplicationLog" fileName="${sys:logPath}/app.log"/>
</Appenders>
和系统属性值有什么区别呢?其实就是System.getProperties();和System.getenv();的区别。下面是一个小例子。
package com.bensonlin.service.common;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
public class Main {
public static void main(String\[\] args) {
Properties properties = System.getProperties();
Iterator i = properties.entrySet().iterator();
while (i.hasNext()) {
Map.Entry entry = (Map.Entry) i.next();
Object key = entry.getKey();
Object value = entry.getValue();
System.out.println(key + "=" + value);
}
System.out.println("===================");
Map map = System.getenv();
Iterator it = map.entrySet().iterator();
while (it.hasNext()) {
Entry entry = (Entry) it.next();
System.out.print(entry.getKey() + "=");
System.out.println(entry.getValue());
}
}
}
输出(摘取部分):
java.runtime.name=Java(TM) SE Runtime Environment
sun.boot.library.path=C:\\Program Files\\Java\\jdk1.8.0_25\\jre\\bin
java.vm.version=25.25-b02
java.vm.vendor=Oracle Corporation
java.vendor.url=http://java.oracle.com/
path.separator=;
...
===================
JAVA\_HOME=C:\\Program Files\\Java\\jdk1.8.0\_25
TEMP=D:\\Temp
ProgramFiles=C:\\Program Files
...
可以看到其实Environment是获取环境变量,而System Properties获取的更多是与Java相关的值
---------------------
作者:HermanChow
来源:CSDN
原文:https://blog.csdn.net/u013160017/article/details/81392154
版权声明:本文为博主原创文章,转载请附上博文链接!