一文搞定log4j2下的xml配置&日志对性能影响分析

hahaha_2568

已于 2024-04-24 11:44:33 修改

阅读量1.5k

点赞数 21

文章标签： log4j

于 2024-03-30 15:28:34 首次发布

本文链接：https://blog.csdn.net/hahaha_2568/article/details/135231640

版权

本文详细介绍了如何在SpringBoot项目中迁移并配置log4j2，包括其性能优势、pom.xml的导入策略，XML配置的各个部分如appender、过滤设置和文件管理，以及日志对系统性能的影响和如何将日志定向到特定文件夹。

摘要由CSDN通过智能技术生成

本文内容：log4j2框架的学习，为什么要选择log4j2？spring boot中如何导入log4j2？其xml配置是如何生效的，各个标签的含义是什么？浅析日志打印对性能的影响。以及附加：如何将指定log打印到指定文件夹下。

1. log4j2性能简介

问题引入：log4j2与logback都是常用的Java日志框架。公司项目中，需要将logback升级为log4j2。为什么要选择log4j2呢？原因如下：

log4j2在高性能场景下表现更优，在多线程场景下，log4j2的吞吐量比logback高出了10倍。
logback是阻塞队列，同样输出日志30M下，logback写盘时间长造成堆积，会造成JVM占用更多。而log4j2支持非阻塞日志处理，有利于提高系统性能。
丢数据情况少，log4j2内部报的Exception会被发现，而logback不会。
logback当xml配置改变后，要重启服务器，log4j2不需要

这里对项目中为什么选择log4j2进行介绍，“4”中对log在项目的重要性进行分析。

2. pom坐标的导入

以maven为例，在spring boot项目下，导入spring-boot-starter，默认情况下，spring boot使用的是logback框架，需要排除掉spring-boot-starter-logging，该jar包与log4j2存在冲突。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

后续再导入spring-boot-starter-log4j2依赖即可。

<!--导入log4j2依赖的jar包-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

在项目中，如果有地方导入了logback-classic、logback-core，需要把这二个包也排除掉，不然会项目启动时会冲突。（项目下引用jar包查看方法，可查看社区版idea下maven helper进行jar包依赖关系查看-CSDN博客

如果在导入过程中，出现Unresolved dependency: 'org.springframework.boot:spring-boot-starter:jar:unknown'报错，pom.xml中添加以下标签，springboot项目必须依赖spring-boot-starter-parent，所有springboot都是spring-boot-starter-parent的子项目。

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
    </parent>

以上是springboot项目代码中的坐标导入。如果想单独导入log4j2的坐标，可以通过以下坐标，但是这样会导致与springboot缺乏整合：

<!--  log4j2下demo  -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.12.1</version>
</dependency>

3. xml文件的配置与解析

3.1 log配置示例

第一步建立springboot项目，建立springboot启动类，方便自己demo测试。在xml中，可以概括为：常量设置、appender定义、logger引用三个模块。由于xml文件中配置细节较多，本文以示例为主，可类似推广。

在下列示例中，我对各个模块功能进行了详细介绍：

<?xml version="1.0" encoding="UTF-8"?>

<!--status设置Log4j2内部异常打印日志的级别, 可以不设置,
monitorInterval表示Log4j2每30秒检查一次配置文件是否有更改-->
<configuration status="WARN" monitorInterval="30">
    <!--公用变量配置-->
    <Properties>
        <!--设置变量名为: log_dir, 并设置值。本配置中将log打印到项目最外层文件路径的/export/logs文件夹下-->
        <Property name="log_dir" value="/export/logs" />
        <!--打印log前, 一般会将日志格式化, 为此设置该变量-->
        <Property name='log_format' value="%d{yyyy-MM-dd HH:mm:ss} %-5level %L %M - %msg%n"/>
    </Properties>

    <!--定义所有的appender, 可以理解为功能函数, 具体谁使用需要在<Loggers>中调用-->
    <Appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--只输出info级别及以上的日志, onMismatch不匹配直接拒绝-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出日志的格式-->
            <PatternLayout pattern="${log_format}"/>
        </console>

        <!--info级别日志appender,
        name用于在后续<Loggers>中引用, fileName为输出路径,
        filePattern为滚动更新文件, 文件重命名格式-->
        <RollingFile name="info_appender" fileName="${log_dir}/info .log"
                     filePattern="logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--该appender下的log输出格式-->
            <PatternLayout pattern="${log_format}"/>
            <!--指定滚动触发策略-->
            <Policies>
                <!--基于时间的触发策略, 如果没有指定时间间隔, 默认每天滚动一次-->
                <TimeBasedTriggeringPolicy/>
                <!--基于文件大小的触发策略, 达到100M发生滚动-->
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <filters>
                <!--是否为warn及以上？是, 则onMatch拒绝写入。否, onMismatch则保持中立, 时间被后续过滤器处理-->
                <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
                <!--是否为info及以上？是, 则接受log打印-->
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            </filters>
            <DefaultRolloverStrategy>
                <Delete basePath="/export/Domains/plus.jd.com/esStorage/" maxDepth="1">
                    <!--要删除文件的名称, 匹配所有以es.开头并以.log结尾的文件-->
                    <IfFileName glob="es.*.log" />
                    <!--要删除文件多少天未被更改, 当文件的最后修改时间超过两天时, 文件才会被删除-->
                    <IfLastModified age="2d" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

        <!--同理info的appender, 可以设置debug、error等级别的专有appdnder-->

    </Appenders>

    <loggers>
        <Root level="debug">
            <!--进入父类日志打印器后, 所有匹配的AppenderRef, 都会输出打印-->
            <AppenderRef ref="Console"/>
            <AppenderRef ref="info_appender"/>
        </Root>

        <!--org.example.dao 包及其子包中的 "info" 级别及更严重的日志消息，会引用info_appender
        additivity绝对打印后, 是否继续引用父类<Root>,
        includeLocation是否在日志输出中包含代码中记录日志请求的位置信息
        -->
        <Logger name="org.example.dao" level="info" includeLocation="false" additivity="false">
            <AppenderRef ref="info_appender"/>
        </Logger>

    </loggers>

</configuration>

3.2 log级别区分

以上简单demo，基本包含了常用的xml配置。日志级别有OFF > FATAL > ERROR > WARN > INFO > DEBUBG > TRACE > ALL。一般情况下，用的最多的是ERRO、INFO在大促期间，为了提升系统性能，可以日志降级，只打印ERRO日志。

3.3 log输出格式定义

在<Property/>中设置了log_format变量，这里对具体字符含义进行解释：

%d{yyyy-MM-dd HH:mm:ss}: log生成时间，输出格式为: "年-月-日时:分:秒"
%-5level: 级别从左显示5个字符宽度
%class{36}: 类名最长36个字符
%L: 日志输出行数
%M: 日志输出方法名
%msg: 需要打印的日志内容
%n: 换行符

等等还有很多格式, 读者如有需要, 可以再详细查找。格式中，需要注意log生成时间、以及log行号问题，行号可以帮住定位到具体问题代码所在位置，方便问题查找。在<Loggers>中如果使用了<AsyncRoot>异步日志处理事件，需要注意行号是否打印的问题，异步会默认关闭打印行号。

3.4 appender中的过滤设置

在ThresholdFilter中，onMatch表示是level级别及以上，onMismatch表示不是level级别及以上。其中，onMatch和MisMatch的参数解释如下：

DENY：拒绝该时间，不允许通过
NEUTRAL：保持中立，后续过滤器继续匹配
ACCEPT：接受事件，允许通过

3.5 滚动更新、删除触发规则

在标签<Policies>中，可以设置日志的滚动更新策略，可以指定log输出文件，多久发生滚动跟新拆分，它可以基于时间，也可以基于当前文件大小，在示例中，已做解释。

以上是滚动更新策略，当文件一直滚动，则会导致堆积。如何删除文件呢？在删除方面，可以在<Delete>下进行配置，可以设置需要扫面的文件路径、扫描深度、删除哪类名字的文件、多久未被修改则发生删除......。

如以下图片包含了滚动更新后的文件名，此时则可以根据设置，去删除具体的文件。在3.1 log配置示例中，可查看范例。

3.6 <loggers>标签

在该标签中，可以定义哪些log打印到哪个文件夹，在<root>中，定义的是根日志收集器。<logger>中，可以定义具体包的打印规则，注意<logger>中的additivity属性。可以防止在root中二次打印，增加文件累赘。如果<logger>收集器无法匹配，将会在<root>继续匹配。

使用中，主要注意事项：

log是否在多个appender中打印
<logger>和<root>是都需要重复打印
<root>是所有其他日志记录器的根

4. 日志对系统性能影响分析

log输出过多，导致磁盘打满，将会阻塞线程，rpc接口可用率将会下降
需要设置好定时清理策略，防止日志影响服务性能
异步日志可以优化性能，提升接口响应时间
日志打印需要可读性强，易于解析

在以下文章中，分享了日志的重要性，及其常见问题，读者如希望对日志打印进行研究，也可参考以下博客，文章分别来自美团和京东：

日志导致线程Block的这些坑，你不得不防 - 美团技术团队

谁家日志在拖系统性能后腿？

6. 如何将指定log打印到指定文件夹？

在log4j2的配置中，可以通过如下代码，将名为“specifyFileOut”的log全部打印到/export/LogFile.log目录下。

<appenders>
    <!--  定义appender -->
         <RollingFile name="specifyLog" fileName="/export/LogFile.log"
                     filePattern=".log">
            <PatternLayout>
                <Pattern>%msg%n</Pattern>
            </PatternLayout>
        </RollingFile>
</appenders>


<loggers>
      <logger name="specifyFileOut" additivity="false" level="ERROR">
            <appender-ref ref="specifyLog" level="ERROR" />
        </logger>
</loggers>

在代码中，定义logger名为specifyFileOut，代替原来的类名.class，后续对需要打印的log使用specifyFileLog.log函数，即可将日志打印到指定的文件夹下。

private  final Logger specifyFileLog = LoggerFactory.getLogger("specifyFileOut");

hahaha_2568

关注

21
点赞
踩
17

收藏

觉得还不错? 一键收藏
1
评论
一文搞定log4j2下的xml配置&日志对性能影响分析

问题引入：log4j2与logback都是常用的Java日志框架。公司项目中，需要将logback升级为log4j2。为什么要选择log4j2呢？log4j2在高性能场景下表现更优，在多线程场景下，log4j2的吞吐量比logback高出了10倍。logback是阻塞队列，同样输出日志30M下，logback写盘时间长造成堆积，会造成JVM占用更多。而log4j2支持非阻塞日志处理，有利于提高系统性能。丢数据情况少，log4j2内部报的Exception会被发现，而logback不会。
复制链接

扫一扫