最近做了个给项目指定log strategy的任务,才算是正式研究了一下log4j
,有几个比较实用的点,特此记录一下。
1. customize log4j config file path
一般而言,在Java project
中log4j
的配置文件log4j.properties
放在/src/resources
即可被自动识别,倘若放在其他路径的话则会收获一个warning
:
log4j: WARN No appenders could be found for logger (com.xxx.yyy...).
log4j: WARN Please initialize the log4j system properly.
log4j: WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
那么为什么要放在其他路径下,放在默认就好了呀?
这是因为在build
的时候,/src
下所有文件都会被打包到jar
包里面。
设想一下,当我们完成部署之后,发生了问题需要调试却发现日志信息不够用的时候,或者发现日志太过泛滥想要精简的时候,需要修改logLevel
来进行调整。
但由于log4j.properties
在jar
包内部,修改之后就必须build
新的jar
包并重新部署,这显得并不是那么灵活。那么怎么办?
当我一筹莫展的时候,同事Steven
告诉我log4j
提供了一个类:org.apache.log4j.PropertyConfigurator
,PropertyConfigurator文档的第一句解释就是
Allows the configuration of log4j from an external file.
此处要用到的具体的method
是
public static void configure(String configFilename)
其实此处configFilename
叫做configFilePath
更合适,因为要指定的是路径,而且需要绝对路径。
NOTE
需要注意的是这个路径要考虑到开发环境和生产环境, 假设路径是在和src
同级的conf
下,即/conf/log4j.properties
。
那么在package
的时候最好也放在该目录下,这里的处理应该在/assembly/bin.xml
下指定,而这个xml
文件的路径则是在pom.xml
中指定。
如果两个环境下的configFilePath
不一致的话,那么就需要先判断环境再具体指定。
这里以/conf/log4j.properties
给出通过相对路径获取configFilePath
绝对路径的简单示例:
import java.io.File;
import org.apache.log4j.PropertyConfigurator;
String confPath = "conf";
// 通过相对路径获取绝对路径
String logConfigPath = new File(confPath,"log4j.properties").getCanonicalPath();
PropertyConfigurator.configure(logConfigPath);
2. update and take effect log4j config without restart service
上面已经实现无须重新build jar
包即可更新log4j.properties
,但是想要使更新生效的话,还是需要restart service
才能够reload log4j.properties
,依然有点不够方便.
这时候就该configureAndWatch
登场了
// watch config file every minute and auto-reload if updated
// the unit of delay is milliseconds
PropertyConfigurator.configureAndWatch(logConfigPath, 60000);
更多详情还是看PropertyConfigurator.configureAndWatch
3. the difference between log4j.logger and log4j.category
这两天接到个问题:project
中elasticsearch INFO
级别的日志过于频繁,希望能过滤一下。
查看log4j.properties
时发现相应配置如下
# ElastickSearch
log4j.logger.org.elasticsearch.hadoop=INFO
log4j.logger.org.elasticsearch.hadoop.rest=INFO
由于该配置不是我添加的,于是我便简单地将INFO
全部更新为WARN
,然后观察日志输出,发现并没有生效。
然后我便对其他项的配置研究了大概十几分钟,然后灵光一闪,如下修改就ok了。
# ElastickSearch
log4j.category.org.elasticsearch=WARN
What happened?
我当时首先想到的是log4j.logger.x.y.z.ABC
能生效的是对应的自己写的Package x.y.z
下的Class ABC
,在这个类中一般如此定义logger
:
import org.slf4j.LoggerFactory;
private static Logger logger = LoggerFactory.getLogger(ABC.class);
既然此处对于elasticsearch.logLevel
的设置不生效说明并不没有这个logger
,然后我看到Spark.logLevel
的设置是这样的:
# Spark
log4j.category.org.apache.spark=WARN
于是我就修改如下:
# ElastickSearch
log4j.category.org.elasticsearch.hadoop=WARN
依然没有生效,此时我怀疑是后面的名称接的不对,尝试删除后面的.hadoop
发现ok了。
那么这又是为啥呢?
在看了一遍pom.xml
后,我自己一个看似合理的推理:后面要接依赖包的groupId
.
<dependency>
<groupId>org.apache.spark</groupId>
<artifactId>spark-core_2.11</artifactId>
<version>2.4.3</version>
</dependency>
<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-spark-20_2.11</artifactId>
<version>7.0.1</version>
</dependency>
个人总结一下就是:
log4j.logger.LocalClassName
log4j.category.DependencyGroupId
4.how about log4j2 in Spring Boot 2.x?
由于另一个project
使用了Spring Boot 2.x
, 而从 Spring Boot 1.4
开始的版本就要用log4j2
了, 因而对log4j2
也做了些工作。
如果想实现上面提到的customize log4j config file path
和update and take effect log4j config without restart service
,log4j2
和log4j
很不一样,关键是更简单了。
log4j2
虽然能支持XML
、json
和properties
三种格式,但Spring Boot 2.x
只能自动识别XML
,如果想使用另外两种格式来配置的话,需要引入额外的dependency
来识别,具体可以上官网文档找找。
对于Spring Boot 2.x
而言,它会在project
内自动搜寻log4j2
的XML
配置文件,只不过对名称有具体要求:log4j2-spring.xml
或者log4j2.xml
(看这里)
对标log4j
中PropertyConfigurator.configureAndWatch
, 只需要log4j2-spring.xml
中配置monitorInterval
即可:
<?xml version="1.0" encoding="UTF-8"?>
<!--status: logLevel for log4j2 self internal, monitorInterval(seconds): watch and reload if updated-->
<configuration status="WARN" monitorInterval="60">
<appenders>
...
</appenders>
<loggers>
...
</loggers>
</configuration>
是不是更加简单?
对于??第三点中dependency
的logLevel
设置,我在使用log4j2
还未碰到category
,参考当前使用的配置文件,谨慎怀疑是在<loggers><loggers>
中使用<Logger name="org.apache.xxx" level="error" />
来配置。
如果错误,还请斧正。