美文网首页
【日志】Log4j2配置

【日志】Log4j2配置

作者: 嘻洋洋 | 来源:发表于2021-11-11 20:18 被阅读0次

    在同步日志模式下, Logback的性能是最糟糕的,log4j2的性能无论在同步日志模式还是异步日志模式下都是最佳的。本章主要介绍Spring Boot如何集成并配置使用Log4j2

    1.准备工作

    引入Log4j2依赖包,其它依赖和Logback一样,使用SLF4J统一输出

    <dependency>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-web</artifactId>  
     <!--去掉springboot自带的logback日志框架,因为项目要用log4j2框架-->
        <exclusions> 
            <exclusion>  
                <groupId>org.springframework.boot</groupId>  
                <artifactId>spring-boot-starter-logging</artifactId>  
            </exclusion>  
        </exclusions>  
    </dependency> 
    <!-- 引入log4j2依赖 -->  
    <dependency> 
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-log4j2</artifactId>  
    </dependency> 
    

    然后需要在resource下面添加log4j2.xml配置文件,当然了如果你不添加,springboo会提示你没有对应文件,并使用默认的配置文件,这个时候级别可以在application.properties中配置

    logging.level.root=error
    

    2. 配置log4j2.xml

    和logback配置类似,主要是含有loggers、appenders,其中loggers由logger,root组成。appenders由console(控制台),File、RollingFile(输出文件)组成,作用和配置和logback差不多

    2.1 appenders

    (1)Console
    用来定义输出到控制台的Appender,主要设置输出格式和level级别

        <console name="Console" target="SYSTEM_OUT">
          <!--输出日志的格式-->
          <PatternLayout pattern="${LOG_PATTERN}"/>
          <!--控制台只输出level及其以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
          <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>
    

    ThresholdFilter: 定义打印级别,onMismatch值设置是否拒绝其它
    (2)File
    用来定义输出到指定位置的文件的Appender

        <!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,适合临时测试用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
          <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>
    

    (3)RollingFile
    用来定义超过指定条件自动删除旧的,创建新的Appender

        <!-- 这个会打印出所有的warn及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
          <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
          <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
          <PatternLayout pattern="${LOG_PATTERN}"/>
          <Policies>
            <!--interval属性用来指定多久滚动一次,默认是1 hour-->
            <TimeBasedTriggeringPolicy interval="1"/>
            <SizeBasedTriggeringPolicy size="10MB"/>
          </Policies>
          <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->
          <DefaultRolloverStrategy max="15"/>
        </RollingFile>
    

    参数说明:

    • PatternLayout:输出格式,不设置默认为:%m%n.
    • filePattern : 指定当发生Rolling时,文件的转移和重命名规则,定义的日志文件后缀精确的时间决定了定期生成日志文件. 精确到dd, 即%d{yyyy-MM-dd}, 则会每天生成一个文件, 精确到HH(%d{yyyy-MM-dd-HH}), 则会每时生成一个文件。
    • Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
      TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.
      SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
    • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。注意:这个只是控制某时间段内(根据配置不同)文件的数目,它并不会关心你的目录下一共有多少个日志文件了。

    2.2 Loggers

    Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出

      <!--Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。-->
      <!--然后定义loggers,只有定义了logger并引入的appender,appender才会生效-->
      <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
          <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false,则 子Logger 只会在自己的appender里输出,而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
          <AppenderRef ref="Console"/>
        </Logger>
        <root level="info">
          <appender-ref ref="Console"/>
          <appender-ref ref="Filelog"/>
          <appender-ref ref="RollingFileInfo"/>
          <appender-ref ref="RollingFileWarn"/>
          <appender-ref ref="RollingFileError"/>
        </root>
      </loggers>
    

    参数说明:

    • name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
    • AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

    2.3 Properties

    变量配置,类似常量定义

      <!--变量配置-->
      <Properties>
        <!-- 格式化输出:%date表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->
        <!-- %logger{36} 表示 Logger 名字最长36个字符 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定义日志存储的路径 -->
        <property name="FILE_PATH" value="更换为你的日志路径" />
        <property name="FILE_NAME" value="更换为你的项目名" />
      </Properties>
    

    3.SpringBoot 配置 log4j2

    默认情况下springboot是不将日志输出到日志文件中,这里对日志框架的支持有两种配置方式(和logback一样):
    (1)application.properties 或 application.yml (系统层面)
    (2)logback-spring.xml (自定义文件方式)

    3.1 application.yml

    logging:
      config: xxxx.xml
      level:
        cn.jay.repository: trace
    

    默认名log4j2-spring.xml,可以省下在application.yml中配置,如果自定义了文件名,需要在application.yml中配置

    3.2 log4j2-spring.xml

    此种方式可以处理比较复杂的情况,比如区分 info 和 error 日志、每天产生一个日志文件。

    <!-- OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    <configuration status="WARN">
        <Properties>
            <!-- 日志显示模板格式 -->
            <Property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %F(%L) - %m%n"/>
            <!-- 控制台日志格式 -->
            <Property name="LOG_PATTERN_CONSOLE" value="%style{%d{HH:mm:ss.SSS}}{blue} %highlight{%-5level} %style{%logger{36}}{bright,Magenta} - %m%n"/>
            <!-- 保存日志文件目录 -->
            <Property name="LOG_PATH" value="/HXG/log/erp-settlement"/>
            <!-- 应用名称 -->
            <property name="APP_NAME" value="cw"/>
            <!-- 日志文件的最大容量 -->
            <Property name="FILE_SIZE" value="100MB"/>
            <!-- 备份的文件夹 -->
            <Property name="BACKUP_FOLDER" value="$${date:yyyy-MM}"/>
            <!-- 备份文件的后缀 -->
            <Property name="FILE_SUFFIX" value="%d{yyyy-MM-dd}-%i.log"/>
        </Properties>
        <appenders>
            <!-- 控制台的输出配置 -->
            <console name="CONSOLE" target="SYSTEM_OUT">
                <!-- 输出日志的格式 -->
                <PatternLayout charset="UTF-8" pattern="${LOG_PATTERN_CONSOLE}"/>
            </console>
            <!--
                该RollingFile存储INFO级别的日志,
                默认存储到fileName文件中
                超过SizeBasedTriggeringPolicy的设定值,则存储到filePattern文件中
            -->
            <RollingFile name="ROLLING_FILE_INFO" fileName="${LOG_PATH}/${APP_NAME}-info.log"
                    filePattern="${LOG_PATH}/${APP_NAME}-info-${FILE_SUFFIX}">
                <!-- 控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
                <!-- 写入日志文件的模板 -->
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    <!-- interval属性用来指定多久滚动一次,默认是1 hour -->
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="${FILE_SIZE}"/>
                </Policies>
                <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,超过该数量,会滚动删除前面的记录 -->
                <DefaultRolloverStrategy max="20"/>
            </RollingFile>
            <RollingFile name="ROLLING_FILE_ERROR" fileName="${LOG_PATH}/${APP_NAME}-error.log"
                    filePattern="${LOG_PATH}/${APP_NAME}-error-${FILE_SUFFIX}">
                <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${LOG_PATTERN}"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="${FILE_SIZE}"/>
                </Policies>
            </RollingFile>
        </appenders>
        <loggers>
            <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <!-- 
            <logger name="org.springframework" level="INFO"/>
            <logger name="druid.sql" level="INFO"/>
            <logger name="org.apache" level="INFO"/>
            <logger name="com.alibaba" level="INFO"/>
     -->
            <logger name="com.hao24.modules.erp.supplier.mapper" level="DEBUG" additivity="false">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="ROLLING_FILE_INFO"/>
                <appender-ref ref="ROLLING_FILE_ERROR"/>
            </logger>
            <root level="INFO">
                <appender-ref ref="CONSOLE"/>
                <appender-ref ref="ROLLING_FILE_INFO"/>
                <appender-ref ref="ROLLING_FILE_ERROR"/>
            </root>
        </loggers>
    

    4.定期生成和删除过期日志文件的配置

    通过在DefaultRolloverStrategy 标签下添加Delete标签实现,保留7天的日志

            <RollingRandomAccessFile name="MyFile"
                                     fileName="${LOG_HOME}/${FILE_NAME}.log"
                                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd-HH}-%i.log">
                <PatternLayout
                        pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %class{36}:%M(%L)] - %msg%xEx%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1"/>      <!--每1小时/分/... 生成一个文件, 时间依据filePattern的配置-->
                    <SizeBasedTriggeringPolicy size="5 MB"/>
                </Policies>
                <DefaultRolloverStrategy max="30">
                    <Delete basePath="${LOG_HOME}/$${date:yyyy-MM}/" maxDepth="2">
                        <IfFileName glob="*.log" />
                        <!--!Note: 这里的age必须和filePattern协调, 后者是精确到HH, 这里就要写成xH, xd就不起作用
                        另外, 数字最好>2, 否则可能造成删除的时候, 最近的文件还处于被占用状态,导致删除不成功!-->
                        <!--7天-->
                        <IfLastModified age="168H" />
                    </Delete>
                </DefaultRolloverStrategy>
            </RollingRandomAccessFile>
    

    IfLastModified .age要和filePattern精确的时间一致, 否则貌似无效.

    相关文章

      网友评论

          本文标题:【日志】Log4j2配置

          本文链接:https://www.haomeiwen.com/subject/wibbzltx.html