知方号

知方号

SpringBoot整合log4j2进行日志配置及防坑指南

SpringBoot整合log4j2进行日志配置及防坑指南

写在前面

        最近项目经理要求将原先项目中的日志配置logBack,修改为log4j2,据说是log4j2性能更优于logback,具体快多少,网上有说快10多倍,看来还是很快的,于是新的一波挑战又开始了,网上查找各种资料,官方文档各种啃,最终实现了迁移,所以,鉴于此,特记录一下,谨防遗忘。

SpringBoot整合log4j2进行日志配置及防坑指南1、Log4j2优点

         具体优点可以参考官方文档:https://logging.apache.org/log4j/2.x/

我这边只简单说一下:

相比与其他的日志系统,log4j2丢数据的情况少;在多线程环境下,性能高于logback等10倍以上;利用jdk1.5并发的特性,减少了死锁的发生

这里列举一下,网上关于相关日志系统的性能测试图,仅做参考

 2、SpringBoot整合Log4j2配置2.1>   导入依赖

可以参考SpringBoot官方文档: https://docs.spring.io/spring-boot/docs/1.5.19.RELEASE/reference/htmlsingle/#howto-configure-log4j-for-logging

org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-logging org.springframework.boot spring-boot-starter-log4j2

避坑指南:

由于springboot默认是用logback的日志框架的,所以需要排除logback,不然会出现jar依赖冲突的报错;但是,网上大部分博文,都是以下写法: org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-logging

诚然,这种方法有其存在的合理性,但是如果当前项目中有多个 spring-boot-starter 下的依赖,这时,如果只这样写,往往就会出现配置了日志打印到文件中,但是日志文件就是不能生成,所以,关于这部分配置还是建议采用第一种方式,而且springBoot的官方文档也是这种方式: 

https://docs.spring.io/spring-boot/docs/1.5.19.RELEASE/reference/htmlsingle/#howto-configure-log4j-for-logging

2.2> log4j2配置文件

在你项目的resource目录下,添加一个配置文件,文件名为 log4j2.xml 或者 log4j2-spring.xml。

避坑指南:

1、如果定义的配置文件名为:log4j2.xml,此时需要在application.yml中添加如下配置:

# log4j2 日志配置logging: config: classpath:log4j2.xml

2、如果定义的配置文件名为:log4j2-spring.xml,此时则不需要再添加上面的配置(建议采用此种方式)

3、log4j是通过一个.properties的文件作为主配置文件的,而现在的log4j2则已经弃用了这种方式,采用的是.xml,.json或者.jsn这种方式来做,可能这也是技术发展的一个必然性,况且properties文件的可阅读性不友好。这里给出一个模版,供大家参考。(模板如下)

2.3> 配置参数解释

这里仅简单做一下介绍,详细介绍可参考官方文档:https://logging.apache.org/log4j/2.x/

1、日志级别

trace:追踪,就是程序推进一下,可以写个trace输出debug:调试,一般作为最低级别,trace基本不用。info: 输出重要的信息,使用较多warn: 警告,有些信息不是错误信息,但也要给程序员一些提示。error:错误信息。用的也很多。fatal:致命错误。

2、输出源

CONSOLE(输出到控制台)FILE (输出到文件)

格式

SimpleLayout: 以简单的形式显示HTMLLayout: 以HTML表格显示PatternLayout:自定义形式显示

PatternLayout自定义日志布局:

%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志产生时间,输出到毫秒的时间%-5level : 输出日志级别,-5表示左对齐并且固定输出5个字符,如果不足在右边补0%c : logger的名称(%logger)%t : 输出当前线程名称%p : 日志输出格式%m : 日志内容,即 logger.info("message")%n : 换行符%C : Java类名(%F)%L : 行号%M : 方法名%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数hostName : 本地机器名hostAddress : 本地ip地址2.4> log4j2.xml配置解释根节点Configuration有两个属性:statusmonitorinterval有两个子节点:AppendersLoggers(表明可以定义多个Appender和Logger).status用来指定log4j本身的打印日志的级别.monitorinterval用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.Appenders节点常见的有三种子节点:Console、RollingFile、FileConsole节点用来定义输出到控制台的Appender.name:指定Appender的名字.target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.PatternLayout:输出格式,不设置默认为:%m%n.File节点用来定义输出到指定位置的文件的Appender.name:指定Appender的名字.fileName:指定输出日志的目的文件带全路径的文件名.PatternLayout:输出格式,不设置默认为:%m%n.RollingFile节点用来定义超过指定条件自动删除旧的创建新的Appender.name:指定Appender的名字.fileName:指定输出日志的目的文件带全路径的文件名.PatternLayout:输出格式,不设置默认为:%m%n.filePattern : 指定当发生Rolling时,文件的转移和重命名规则.Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。Loggers节点,常见的有两种:Root和Logger.Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出level:日志输出级别,共有8个级别,按照从低到高为:All

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至lizi9903@foxmail.com举报,一经查实,本站将立刻删除。