(原创)Java log4j的几个实用tips

最近做了个给项目指定log strategy的任务,才算是正式研究了一下log4j,有几个比较实用的点,特此记录一下。

1. customize log4j config file path

一般而言,在Java projectlog4j的配置文件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.propertiesjar包内部,修改之后就必须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

这两天接到个问题:projectelasticsearch 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 pathupdate and take effect log4j config without restart service,log4j2log4j很不一样,关键是更简单了。
log4j2虽然能支持XML、jsonproperties三种格式,但Spring Boot 2.x只能自动识别XML,如果想使用另外两种格式来配置的话,需要引入额外的dependency来识别,具体可以上官网文档找找。

对于Spring Boot 2.x而言,它会在project内自动搜寻log4j2XML配置文件,只不过对名称有具体要求:log4j2-spring.xml或者log4j2.xml看这里

1.png

对标log4jPropertyConfigurator.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>

是不是更加简单?

对于??第三点中dependencylogLevel设置,我在使用log4j2还未碰到category,参考当前使用的配置文件,谨慎怀疑是在<loggers><loggers>中使用<Logger name="org.apache.xxx" level="error" />来配置。

如果错误,还请斧正。

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,979评论 0 6
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 5,018评论 1 13
  • 作为Java开发人员,对于日志记录框架一定非常熟悉。而且几乎在所有应用里面,一定会用到各种各样的日志框架用来记录程...
    意识流丶阅读 13,919评论 0 13
  • 日志解决方案这么多,为何我们选择slf4j+log4j2来作为日志系统呢?首先我们来将常见的日志作对比。 1 日志...
    Jerry_Liang阅读 5,422评论 0 5
  • JAVA && Spring && SpringBoot2.x — 学习目录[https://www.jiansh...
    小胖学编程阅读 2,074评论 0 8