您现在的位置是：首页 >技术交流 >springboot系列四：集成log4j2网站首页技术交流

springboot系列四：集成log4j2

码上飞跃 2023-07-08 04:00:03
简介springboot系列四：集成log4j2

常见的日志框架

常见的日志框架有log4j、logback和log4j2。三者作者都是Ceki Gülcü。slf4j是The Simple Logging Facade for Java的简称，是log4j、logback和log4j2的统一开发接口封装，作为日志门面，很大程度上提高了易用性和可维护性。最早为log4j（Log for Java），再后来基于log4j开发出一套统一的接口slf4j。并在log4j和slf4j的基础上开发了logback，在性能上也做了优化。log4j2虽然与log4j有很大的相似性，但是log4j2有极大地提升了性能，并有更高的并发性，并支持异步log。
所以，无论在性能上还是并发性上，log4j2都是目前最优的日志框架。

pom依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

springboot默认使用的日志框架为logback，要想使用log4j2，需要从spring-boot-starter-web中排除对spring-boot-starter-logging依赖。

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

然后，再引入log4j2的依赖，内部依赖了slf4j、log4j。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

log4j2配置

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别从低到高优先级为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF。-->
<!--status：设置 log4j2 自身内部的信息输出，可以不设置-->
<!--monitorInterval：监视配置文件变化间隔时间，单位秒，Log4j2 能够自动检测配置文件是否修改，同时更新配置-->
<configuration monitorInterval="30">
    <!--定义属性，在下方方便维护引用-->
    <properties>
        <!--当天文件保存目录-->
        <property name="logDir">./logs</property>
        <!--历史文件保存目录-->
        <property name="historyLogDir">./logs/history</property>
        <!--如果当天日志文件大于100MB，则存档-->
        <property name="splitSize">100MB</property>
        <!--文件保存个数，这里的30说明可保留30个，即30天-->
        <property name="fileCount">30</property>
        <!--输出格式-->
        <property name="logPattern">%d{yyyy-MM-dd HH:mm:ss.SSS} => [%thread] => %-5level %logger{50}:(%line) - %msg%n</property>
    </properties>

    <!--先定义所有的 appender 附加器-->
    <appenders>
        <!--控制台输出配置-->
        <console name="Console" target="SYSTEM_OUT">
            <filters>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            </filters>
            <!--输出日志的格式
                %d表示日期时间，
                %thread表示线程名，
                %-5level：级别从左显示5个字符宽度
                %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
                %line：表示行号
                %msg：日志消息
                %n是换行符-->
            <PatternLayout pattern="${logPattern}" />
        </console>

        <!--文件存储文件设置-->
        <!--fileName：文件存储路径及名称，可以是绝对路径或者相对路径; 存储的永远是最新的日志信息-->
        <!--filePattern：当 fileName 指定的文件大小超过限制，就会根据此文件名规则新建存档目录与文件，同时将 fileName 文件中的
         内容剪切到存档文件中，如下配置，会新建存档路径 logs/history/error-2023-03-26-1.log -->
        <!--以下只保存debug信息-->
        <RollingFile name="fileDebug" fileName="${logDir}/debug.log"
                     filePattern="${historyLogDir}/debug-%d{yyyy-MM-dd}-%i.log">
            <filters>
                <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL" />
                <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY" />
            </filters>
            <PatternLayout pattern="${logPattern}" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <!--日志文件大小超过多少时进行存档-->
                <SizeBasedTriggeringPolicy size="${splitSize}" />
            </Policies>
            <DefaultRolloverStrategy max="${fileCount}" />
        </RollingFile>

        <!--以下只保存info信息-->
        <RollingFile name="fileInfo" fileName="${logDir}/info.log"
                     filePattern="${historyLogDir}/info-%d{yyyy-MM-dd}-%i.log">
            <filters>
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL" />
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />
            </filters>
            <PatternLayout pattern="${logPattern}" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="${splitSize}" />
            </Policies>
            <DefaultRolloverStrategy max="${fileCount}" />
        </RollingFile>

        <!--以下只保存warn信息-->
        <RollingFile name="fileWarn" fileName="${logDir}/warn.log"
                     filePattern="${historyLogDir}/warn-%d{yyyy-MM-dd}-%i.log">
            <filters>
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL" />
                <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY" />
            </filters>
            <PatternLayout pattern="${logPattern}" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="${splitSize}" />
            </Policies>
            <DefaultRolloverStrategy max="${fileCount}" />
        </RollingFile>

        <!--以下只保存error信息-->
        <RollingFile name="fileError" fileName="${logDir}/error.log"
                     filePattern="${historyLogDir}/error-%d{yyyy-MM-dd}-%i.log">
            <filters>
                <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY" />
            </filters>
            <PatternLayout pattern="${logPattern}" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="${splitSize}" />
            </Policies>
            <DefaultRolloverStrategy max="${fileCount}" />
        </RollingFile>

        <!--以下保存api请求信息-->
        <RollingFile name="apiInfo" fileName="${logDir}/api.log"
                     filePattern="${historyLogDir}/api-%d{yyyy-MM-dd}-%i.log">
            <filters>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />
            </filters>
            <PatternLayout pattern="${logPattern}" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="${splitSize}" />
            </Policies>
            <DefaultRolloverStrategy max="${fileCount}" />
        </RollingFile>

        <!-- 整合elk -->
        <Socket name="logstash" host="127.0.0.1" port="4560" protocol="TCP">
            <PatternLayout pattern="${logPattern}" />
        </Socket>
    </appenders>

    <!--
    1、root与logger是父子关系，没有特别定义logger的都默认为root。
    2、任何一个类只会和一个logger对应，要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
    3、appender-ref 用于引用上面定义好的 appender 日志追加器，只有引用了，上面的 appender 才能生效. -->
    <loggers>
        <!--过滤掉 spring 和 mybatis 的一些无用的 DEBUG 信息;也可以单独指定自己的某个包-->
        <!--以下包中ERROR级别以上日志在root中将被记录-->
        <logger name="org.springframework" level="ERROR"></logger>
        <logger name="org.mybatis" level="ERROR"></logger>
        <logger name="org.hibernate" level="ERROR"></logger>
        <logger name="org.apache" level="ERROR"></logger>
        <logger name="com.baomidou" level="ERROR"></logger>
        <logger name="com.zaxxer" level="ERROR"></logger>
        <logger name="springfox.documentation" level="ERROR"></logger>
        <!--com.yyl.system包中的DEBUG以上信息在以下的appender中输出，additivity所有日志还要向控制台和allLog中输出-->
        <logger name="com.yyl.system" level="DEBUG" additivity="true">
            <appender-ref ref="fileDebug" />
            <appender-ref ref="fileInfo" />
            <appender-ref ref="fileWarn" />
            <appender-ref ref="fileError" />
            <appender-ref ref="apiInfo" />
            <appender-ref ref="logstash" />
        </logger>

        <root level="INFO">
            <appender-ref ref="Console" />
        </root>
    </loggers>
</configuration>

log4j2配置文件详解

要想使log4j2配置生效，需要在resources目录下新建log4j2.xml，springboot会自动找到配置文件，并加载。

日志级别

log4j2共分8个日志级别，按从低到高排列为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF：

  • ALL：最低等级日志级别，输出所有日志；
  • TRACE：追踪日志，如程序启动进程日志；
  • DEBUG：程序调试信息；
  • INFO：应用程序提示信息；
  • WARN：告警信息；
  • ERROR：程序报错信息；
  • FATAL：程序出错，导致应用程序退出；
  • OFF：关闭日志；
    设置应用程序的日志级别后，将输出该级别及以上的日志。如，设置日志级别为INFO，那么程序会输出INFO、WARN、ERROR及FATAL日志。

monitorInterval

监视配置文件变化间隔时间。如设置为30，表示每隔30s，程序会自动检测配置文件是否修改，如果修改，就更新配置文件。

properties

定义属性，方便在配置文件中引用。我们在这配置了logDir、historyLogDir、splitSize、fileCount及logPattern属性。

  • logDir：日志输出目录；
  • historyLogDir：日志输出历史目录；
  • splitSize：日志存档临界值，如果当天日志大于临界值，则存档，在这配置为100M；
  • fileCount：存档文件个数。在这里配置为30，相当于保留最近30天的日志记录；
  • logPattern：日志输出格式；

appenders

定义一系列的日志输出，可输出至控制台或者文件中。主要有三种日志输出方式：

  • Console：定义输出至控制台的方式；
  • File：定义输出至文件的方式；
  • RollingFile：定义输出至文件的方式，但会以一定的策略删除旧日志文件，并创建新的日志文件；
    三种方式有共同的子节点。

filters

定义日志输出等级。
如果想输出某个等级及其以上的日志，可做如下配置：

<filters>
    <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />
</filters>

以上配置过滤INFO级别及其以上的日志。
如果想单独输出某个等级的日志，可做如下配置：

<filters>
    <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL" />
    <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY" />
</filters>

以上配置只过滤DEBUG日志，INFO及其以上等级的日志将被拒绝。

Console日志输出

定义日志输出至控制台。主要属性有name、target、filters和PatternLayout。

  • name：自己定义；
  • target：一般配置为SYSTEM_OUT，即将日志通过System.out输出；
  • filters：定义日志输出等级，这里配置等级为INFO，即INFO及以上等级的日志输出到控制台；
  • PatternLayout：定义日志输出格式；

File日志输出

定义日志输出至文件。示例配置如下：

<File name="fileLog" fileName="${logDir}/file.log" append="true">
    <filters>
        <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
    </filters>
    <PatternLayout pattern="${logPattern}" />
</File>

主要属性和子节点有name、fileName、append、filters和PatternLayout。

  • fileName：定义输出文件名；
  • append：当为true时，新增日志将被追加至文件末尾；如果为false，那么新日志将覆盖旧日志；

RollingFile日志输出

也是定义日志输出至文件，不同的是RollingFile可以定义日志文件存档策略。比如按照时间存档，每天备份一次，最大存档30天等等。

<RollingFile name="fileDebug" fileName="${logDir}/debug.log"
             filePattern="${historyLogDir}/debug-%d{yyyy-MM-dd}-%i.log">
    <filters>
        <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL" />
        <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY" />
    </filters>
    <PatternLayout pattern="${logPattern}" />
    <Policies>
        <TimeBasedTriggeringPolicy />
        <!--日志文件大小超过多少时进行存档-->
        <SizeBasedTriggeringPolicy size="${splitSize}" />
    </Policies>
    <DefaultRolloverStrategy max="${fileCount}" />
</RollingFile>

主要属性和子节点有name、fileName、filePattern、filters、PatternLayout、Policies、TimeBasedTriggeringPolicy、SizeBasedTriggeringPolicy和DefaultRolloverStrategy。

  • fileName：定义现在日志输出文件名；
  • filePattern：定义历史日志文件名格式；
  • filters：以上只输出debug日志；
  • Policies：定义日志输出策略；
  • TimeBasedTriggeringPolicy：指定多长时间触发日志备份策略，这里默认为一天。还可以设置interval和modulate属性；
  • SizeBasedTriggeringPolicy：指定日志文件多大时触发日志备份策略，这里设置为100MB。即如果当天日志一次超过100MB，备份为debug-2023-05-02-1.log。如果再次超过100MB，则备份为debug-2023-05-02-2.log；
  • DefaultRolloverStrategy：设置日志文档存档个数，max指定能保存的文件个数。超过后，之前的文件将被删除；

Socket日志输出

定义日志输出至数据库或者其它日志管理系统，如elk等。

<Socket name="logstash" host="127.0.0.1" port="4560" protocol="TCP">
    <PatternLayout pattern="${logPattern}" />
</Socket>

以上定义日志输出至127.0.0.1:4560服务器，也就是我本地创建的elk日志管理系统。elk的搭建将在下一章讲解。

loggers

所有在appenders里定义的appender都需要在logger下引用，否则appender的配置就不会生效。
如果要过滤掉一些debug信息，可以在logger中屏蔽掉，如下屏蔽掉org.springframework中error级别以下的日志：

<logger name="org.springframework" level="ERROR"></logger>

设置项目中的日志输出至指定的文件，并且不再在控制台中输出，配置如下：

<logger name="com.yyl.system" level="DEBUG" additivity="true">
    <appender-ref ref="fileDebug" />
    <appender-ref ref="fileInfo" />
    <appender-ref ref="fileWarn" />
    <appender-ref ref="fileError" />
    <appender-ref ref="apiInfo" />
    <appender-ref ref="logstash" />
</logger>

root节点为兜底操作，所有在appenders中配置的，但没有在其它logger中输出的，都会在root的logger中输出。

风语者！平时喜欢研究各种技术，目前在从事后端开发工作，热爱生活、热爱工作。

站长推荐