美文网首页Java
log4j2 配置与使用

log4j2 配置与使用

作者: 丿星纟彖彳亍 | 来源:发表于2020-12-03 11:40 被阅读0次

    log4j2是log4j 1.x 的升级版,2015年5月,Apache宣布log4j1.x 停止更新。最新版为1.2.17。

    log4j2参考了logback的一些优秀的设计,并且修复了一些问题,因此带来了一些重大的提升,主要有:

    • 1、异常处理:在logback中,Appender中的异常不会被应用感知到,但是在log4j2中,提供了一些异常处理机制。
    • 2、性能提升:log4j2相较于log4j 1和logback都具有很明显的性能提升。
    • 3、自动重载配置:参考了logback的设计,提供自动刷新参数配置,可以动态的修改日志的级别而不需要重启应用。
    • 4、无垃圾机制,log4j2在大部分情况下,都可以使用其设计的一套无垃圾机制,避免频繁的日志收集导致的jvm gc。

    1、依赖

    • pom.xml
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>2.3.4.RELEASE</version>
                <exclusions>
                    <!-- 去掉springboot默认配置 -->
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-logging</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
     <!-- log4j2的api、core和web包 -->
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-api</artifactId>
                <version>2.14.0</version>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-core</artifactId>
                <version>2.14.0</version>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-web</artifactId>
                <version>2.14.0</version>
            </dependency>
            <!-- slf4j与log4j2的连接包 注意,不可同时使用log4j-slf4j-impl和log4j-to-slf4j,
            否则会引发循环依赖。详情见log4j官方文档。-->
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-slf4j-impl</artifactId>
                <version>2.14.0</version>
            </dependency>
            <!-- slf4j本身的api -->
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-api</artifactId>
            </dependency>
            <!-- log4j与log4j2的连接包 -->
    <!--        <dependency>-->
    <!--            <groupId>org.apache.logging.log4j</groupId>-->
    <!--            <artifactId>log4j-1.2-api</artifactId>-->
    <!--            <version>2.14.0</version>-->
    <!--        </dependency>-->
            <!-- log4j2支撑完全异步模式的关键api -->
            <dependency>
                <groupId>com.lmax</groupId>
                <artifactId>disruptor</artifactId>
                <version>3.4.2</version>
            </dependency>
    

    2、配置示例

    • log4j2.xml
    <?xml version="1.0" encoding="UTF-8"?>
    <!--1.全异步-->
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    <!--status:用于设置log4j2自身内部日志的信息输出级别(所有日志级别筛选),默认是OFF。当设置成trace时,你会看到log4j2内部各种详细输出
       monitorinterval:用于指定log4j自动重新配置的监测间隔时间,自动检测配置文件的变更和重新配置本身,单位是s,最小是5s。 -->
    <configuration status="error" monitorInterval="30">
        <Properties>
            <!--自定义一些常量,之后使用 ${变量名} 引用-->
            <Property name="baseLogDir">logs</Property>
            <Property name="pattern">%d{yyyyMMdd-HHmmss.SSS} [%level] %c{1} - %msg%n</Property>
        </Properties>
        <!-- appenders:定义输出内容,输出格式,输出方式,日志保存策略等,常用其下三种标签[console,File,RollingFile]-->
        <appenders>
            <!--Console节点用来定义输出到控制台的Appender。
            name:指定Appender的名字.
            target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT。
            PatternLayout:输出日志的格式,不设置默认为:%m%n。-->
            <Console name="Console" target="SYSTEM_OUT">
                <!--level="info" :自定义日志输出级别,
                    onMatch="ACCEPT" :级别在info之上则接受,
                    onMismatch="DENY" :级别在info之下则拒绝-->
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="${pattern}"/>
            </Console>
    
            <!--异步日志配置1,LOG4J有三种日志模式,全异步日志,混合模式,同步日志,性能从高到底,线程越多效率越高,也可以避免日志卡死线程情况发生;
                采用了ArrayBlockingQueue来保存需要异步输出的日志事件.
                bufferSize: 队列中可存储的日志事件的最大数量,默认为128。
                blocking: 默认为true。如果为true,appender将一直等待直到queue中有空闲;如果为false,当队列满的时候,日志事件将被丢弃。
                (如果配置了error appender,要丢弃的日志事件将由error appender处理)
                AppenderRef: 异步调用的Appender的名字,可以配置多个。
                -->
            <Async name="ASYNC" bufferSize="128" includeLocation="true">
                <AppenderRef ref="RollingFileWarn"/>
                <AppenderRef ref="RollingFileError"/>
            </Async>
    
            <!--File:节点用来定义同步输出到指定位置的文件的Appender。
                name:指定Appender的名字。
                fileName:指定输出日志的目的文件带全路径的文件名。
                PatternLayout:输出格式,不设置默认为:%m%n。
                文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用-->
            <File name="test1" fileName="${baseLogDir}/test1.log" append="false">
                <PatternLayout pattern="${pattern}"/>
            </File>
    
            <!--日志文件配置,filePattern为日志文件名称的格式 ${sys:user.home} :项目路径-->
            <RollingFile name="RollingFile" fileName="${baseLogDir}/infoall.log"
                         filePattern="${baseLogDir}/infoall.log.%d{yyyy-MM-dd}">
                <!--日志内容格式-->
                <PatternLayout pattern="%d %5p %c:%L - %m %throwable{separator( --> )}%n"/>
                <!--依据时间创建新的日志文件:1d-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <DefaultRolloverStrategy>
                    <!-- 在轮转时,删除7天之前的,命名符合规则的文件 -->
                    <Delete basePath="${baseLogDir}">
                        <IfFileName glob="infoall.log.*"/>
                        <IfLastModified age="7d"/>
                    </Delete>
                </DefaultRolloverStrategy>
            </RollingFile>
            <!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
            <RollingFile name="RollingFileInfo" fileName="${baseLogDir}/info.log"
                         filePattern="${baseLogDir}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
                <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <!-- Policies :日志滚动策略-->
                <Policies>
                    <!-- TimeBasedTriggeringPolicy :时间滚动策略,默认0点小时产生新的文件,
                         interval="6" : 自定义文件滚动时间间隔,每隔6小时产生新文件,
                         modulate="true" : 产生文件是否以0点偏移时间,即6点,12点,18点,0点-->
                    <TimeBasedTriggeringPolicy interval="6" modulate="true"/>
                    <!-- SizeBasedTriggeringPolicy :文件大小滚动策略-->
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
                <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了20 -->
                <DefaultRolloverStrategy max="20"/>
            </RollingFile>
            <RollingFile name="RollingFileWarn" fileName="${baseLogDir}/warn.log"
                         filePattern="${baseLogDir}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
    
            </RollingFile>
            <RollingFile name="RollingFileError" fileName="${baseLogDir}/error.log"
                         filePattern="${baseLogDir}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
            </RollingFile>
        </appenders>
        <!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
        <loggers>
            <!--    自定义的log输出级别    -->
            <!-- Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出 -->
            <root level="trace">
                <appender-ref ref="Console"/>
                <appender-ref ref="RollingFileInfo"/>
            </root>
            <!--这里配置 过滤日志 用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。-->
            <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
            <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
            <!--Logger节点用来单独指定日志的形式,name为包路径,比如要为org.springframework包下所有日志指定为INFO级别等。 -->
            <logger name="org.springframework" level="INFO"/>
            <logger name="org.mybatis" level="INFO"/>
            <logger name="org.hibernate.validator" level="ERROR"/>
            <!-- 异步日志配置2,使用了Disruptor框架来实现高吞吐
                 additivity="false" : additivity设置事件是否在root logger输出,为了避免重复输出,可以在Logger 标签下设置additivity为”false”-->
            <AsyncLogger name="AsyncLogger" level="trace" includeLocation="true" additivity="false">
                <AppenderRef ref="RollingFile"/>
                <AppenderRef ref="RollingFileInfo"/>
            </AsyncLogger>
        </loggers>
    </configuration>
    <!--%d{HH:mm:ss.SSS} 表示输出到毫秒的时间
        %t 输出当前线程名称
        %-5level 输出日志级别,-5表示左对齐并且固定输出5个字符,如果不足在右边补0
        %logger 输出logger名称,因为Root Logger没有名称,所以没有输出
        %msg 日志文本
        %n 换行
      其他常用的占位符有:
        %F 输出所在的类文件名,如Log4j2Test.java
        %L 输出行号
        %M 输出所在方法名
        %l 输出语句所在的行数, 包括类名、方法名、文件名、行数-->
    <!--2.日志分类-->
    <!-- monitorInterval配置成一个正整数,则每隔这么久的时间(秒),log4j2会刷新一次配置。如果不配置则不会动态刷新 -->
    <!--<Configuration status="INFO" monitorInterval="30">-->
    <!--<Properties>-->
    <!--     应用需要修改为合适的log路径 -->
    <!--    <Property name="baseLogDir">logs</Property>-->
    <!--    <Property name="pattern">%d{yyyyMMdd-HHmmss.SSS} [%level] %c{1} - %msg%n</Property>-->
    <!--</Properties>-->
    <!-- 先定义所有的appender -->
    <!--<Appenders>-->
    <!--     这个输出控制台的配置 -->
    <!--    <Console name="Console" target="SYSTEM_OUT">-->
    <!--        <PatternLayout>-->
    <!--            <Pattern>${pattern}</Pattern>-->
    <!--        </PatternLayout>-->
    <!--    </Console>-->
    <!--     系统日志,可以作为root logger的appender,供打印一些中间件的日志 -->
    <!--    <RollingRandomAccessFile name="SYS_APPENDER" fileName="${baseLogDir}/server.log"-->
    <!--                             filePattern="${baseLogDir}/server.log.%d{yyyyMMddHH}.%i.gz">-->
    <!--        <PatternLayout>-->
    <!--            <Pattern>${pattern}</Pattern>-->
    <!--        </PatternLayout>-->
    <!--        <Policies>-->
    <!--            <SizeBasedTriggeringPolicy size="200MB" />-->
    <!--            <TimeBasedTriggeringPolicy interval="1" modulate="true" />-->
    <!--        </Policies>-->
    <!--        <Filters>-->
    <!--            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />-->
    <!--        </Filters>-->
    <!--         max=6标识一小时内最多产生6个日志文件 -->
    <!--        <DefaultRolloverStrategy max="6">-->
    <!--            对于指定的路径下的指定后缀的文件,只保留1天的日志文件,那么最多会有24小时*6个日志文件 -->
    <!--            <Delete basePath="${baseLogDir}" maxDepth="1">-->
    <!--                <IfFileName glob="*.gz" />-->
    <!--                <IfLastModified age="1d" />-->
    <!--            </Delete>-->
    <!--        </DefaultRolloverStrategy>-->
    <!--    </RollingRandomAccessFile>-->
    <!--     应用info日志 -->
    <!--    <RollingRandomAccessFile name="APPINFO_APPENDER" fileName="${baseLogDir}/appinfo.log"-->
    <!--                             filePattern="${baseLogDir}/appinfo.log.%d{yyyyMMddHH}.%i.gz">-->
    <!--        <PatternLayout>-->
    <!--            <Pattern>${pattern}</Pattern>-->
    <!--        </PatternLayout>-->
    <!--        <Policies>-->
    <!--            <SizeBasedTriggeringPolicy size="500MB" />-->
    <!--            <TimeBasedTriggeringPolicy interval="1" modulate="true" />-->
    <!--        </Policies>-->
    <!--        <Filters>-->
    <!--          当前appender只打印info日志,warn及以上日志忽略,由后面的appender决定是否需要打印 -->
    <!--            <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL" />-->
    <!--            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />-->
    <!--        </Filters>-->
    <!--        max=20标识一小时内最多产生20个日志文件 -->
    <!--        <DefaultRolloverStrategy max="20">-->
    <!--            对于指定的路径下的指定后缀的文件,只保留3天的日志文件,那么最多会有3天*24小时*20个日志文件 -->
    <!--            注意应用需要根据业务需求和磁盘大小评估需要保留的日志个数,对于500M的日志文件来说,要根据应用日志的情况,观察单个日志压缩后文件大小,并计算总大小需要的空间 -->
    <!--            <Delete basePath="${baseLogDir}" maxDepth="1">-->
    <!--                <IfFileName glob="*.gz" />-->
    <!--                <IfLastModified age="3d" />-->
    <!--            </Delete>-->
    <!--        </DefaultRolloverStrategy>-->
    <!--    </RollingRandomAccessFile>-->
    <!--    应用错误日志 -->
    <!--    <RollingRandomAccessFile name="APPERROR_APPENDER" fileName="${baseLogDir}/apperror.log"-->
    <!--                             filePattern="${baseLogDir}/apperror.log.%d{yyyyMMddHH}.%i.gz">-->
    <!--        <PatternLayout>-->
    <!--            <Pattern>${pattern}</Pattern>-->
    <!--        </PatternLayout>-->
    <!--        <Policies>-->
    <!--            <SizeBasedTriggeringPolicy size="500MB" />-->
    <!--            <TimeBasedTriggeringPolicy interval="1" modulate="true" />-->
    <!--        </Policies>-->
    <!--        <Filters>-->
    <!--            <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY" />-->
    <!--        </Filters>-->
    <!--         max=10标识一小时内最多产生10个日志文件 -->
    <!--        <DefaultRolloverStrategy max="10">-->
    <!--            对于指定的路径下的指定后缀的文件,只保留3天的日志文件,那么最多会有3*24小时*10个日志文件 -->
    <!--            <Delete basePath="${baseLogDir}" maxDepth="1">-->
    <!--                <IfFileName glob="*.gz" />-->
    <!--                <IfLastModified age="3d" />-->
    <!--            </Delete>-->
    <!--        </DefaultRolloverStrategy>-->
    <!--    </RollingRandomAccessFile>-->
    <!--</Appenders>-->
    
    <!--<Loggers>-->
    <!--     root是默认的logger,也就是公共的logger,供记录一些不常打印的系统参数或者其他组件参数 -->
    <!--    <AsyncRoot level="WARN">-->
    <!--        <AppenderRef ref="Console" />-->
    <!--        <AppenderRef ref="SYS_APPENDER" />-->
    <!--    </AsyncRoot>-->
    <!--     常打印的应用日志,建议独立配置,并采用异步模式。name根据实际的包名修改,生产环境中additivity建议设置为false以避免在root logger中重复打印 -->
    <!--    <AsyncLogger name="com.unionpay" level="INFO" includeLocation="false" additivity="false">-->
    <!--        <AppenderRef ref="APPINFO_APPENDER" />-->
    <!--        <AppenderRef ref="APPERROR_APPENDER" />-->
    <!--    </AsyncLogger>-->
    <!--</Loggers>-->
    <!--</Configuration>-->
    

    3、使用

    import org.apache.logging.log4j.LogManager;
    import org.apache.logging.log4j.Logger;
     
    public class log4j2Test {
        private static Logger logger= LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);
     
        public static void main(String[] args) {
            for(int i=0;i<3;i++){
                // 记录trace级别的信息
                logger.trace("log4j2日志输出:This is trace message.");
                // 记录debug级别的信息
                logger.debug("log4j2日志输出:This is debug message.");
                // 记录info级别的信息
                logger.info("log4j2日志输出:This is info message.");
                // 记录error级别的信息
                logger.error("log4j2日志输出:This is error message.");
            }
        }
    }
    

    参考文档:

    相关文章

      网友评论

        本文标题:log4j2 配置与使用

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