log4j2配置文件解读

心已赠人 2023-05-21 12:51 9阅读 0赞

>  [https://logging.apache.org/log4j/2.x/][https_logging.apache.org_log4j_2.x]

> log4j2是对**log4j**的升级版，参考了logback的一些优秀的设计，并且修复了一些问题，因此带来了一些重大的提升
> 
> 1.  **异常处理** : 在logback中，Appender中的异常不会被应用感知到，但是在log4j2中，提供了一些异常处理机制
> 2.  **性能提升** : log4j2相较于log4j和logback都具有很明显的性能提升
> 3.  **自动重载配置** : 参考了logback的设计，当然会提供自动刷新参数配置，最实用的就是我们在生产上可以动态的修改日志的级别而不需要重启应用
> 4.  **无垃圾机制** : log4j2在大部分情况下，都可以使用其设计的一套无垃圾机制，避免频繁的日志收集导致的jvm gc

--------------------

# 1 log4j2日志门面+日志实现 #

<dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.13.1</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.13.1</version>
    </dependency>

public class Log4j2Test {
        // 定义日志记录器对象
        // org.apache.logging.log4j.LogManager
        // org.apache.logging.log4j.Logger
        public static final Logger LOGGER = LogManager.getLogger(Log4j2Test.class);
        @Test
        public void testQuick()throws Exception{
            // 日志消息输出
            LOGGER.fatal("fatal");
            LOGGER.error("error"); //默认
            LOGGER.warn("warn");
            LOGGER.info("inf");
            LOGGER.debug("debug");
            LOGGER.trace("trace");
        }

> log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="warn" monitorInterval="5">
        <Appenders>
            <Console name="console" target="SYSTEM_OUT">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36} %L %m%n"/>
            </Console>
        </Appenders>
        <Loggers>
            <Root level="trace">
                <AppenderRef ref="console"/>
            </Root>
        </Loggers>
    </Configuration>

--------------------

# 2 slf4j+log4j2 #

> 目前市面上最主流的日志门面就是SLF4J，虽然Log4j2也是日志门面，因为它的日志实现功能非常强大，性能优越；所以大家一般还是将Log4j2看作是日志的实现，Slf4j + Log4j2应该是未来的大势所趋

<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.13.1</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.13.1</version>
    </dependency>
    
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.12</version>
    </dependency>

@Slf4j
    public class Log4j2Test {
        @Test
        public void testQuick()throws Exception{
            log.error("error");
            log.warn("warn");
            log.info("inf");
            log.debug("debug");
            log.trace("trace");
        }

--------------------

**3 Log4j2配置**

> log4j2默认加载classpath下的 log4j2.xml 文件中的配置

>  控制台打印

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="info" monitorInterval="5">
        <Appenders>
            
            <Console name="console" target="SYSTEM_ERR">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36} %L %m%n" />
            </Console>
        </Appenders>
        <Loggers>
            
            <Root level="trace">
                
                <AppenderRef ref="console" />
            </Root>
        </Loggers>
    </Configuration>

> 输出到文件中

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="info" monitorInterval="5">
        <properties>
            <property name="LOG_HOME">F:/logs</property>
        </properties>
        <Appenders>
            
            <File name="file" fileName="${LOG_HOME}/log4j2.log">
                <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l - %m%n"/>
            </File>
        </Appenders>
        <Loggers>
            <Root level="info">
                <AppenderRef ref="file"/>
            </Root>
        </Loggers>
    </Configuration>

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration>
        <properties>
            <property name="LOG_HOME">F:/logs</property>
        </properties>
        <Appenders>
            
            <RandomAccessFile name="accessFile" fileName="${LOG_HOME}/log4j2.log">
                <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l - %m%n" />
            </RandomAccessFile>
        </Appenders>
        <Loggers>
            <Root level="info">
                <AppenderRef ref="accessFile" />
            </Root>
        </Loggers>
    </Configuration>

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration>
        <properties>
            <property name="LOG_HOME">/logs</property>
            <property name="pattern" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] %l %c{36} - %msg%n"/>
        </properties>
        <Appenders>
            
            <RollingFile name="rollingFile" fileName="${LOG_HOME}/vx_video.log"
                         filePattern="${LOG_HOME}/$${date:yyyy-MM-dd}/vx_video-%d{yyyy-MM-dd-HH-mm}-%i.log">
                
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
                
                <PatternLayout pattern="${pattern}" />
                <Policies>
                    
                    <OnStartupTriggeringPolicy />
                    
                    <SizeBasedTriggeringPolicy size="10 MB" />
                    
                    <TimeBasedTriggeringPolicy />
                </Policies>
                
                <DefaultRolloverStrategy max="30" />
            </RollingFile>
        </Appenders>
        <Loggers>
            <Root level="trace">
                <AppenderRef ref="rollingFile"/>
            </Root>
        </Loggers>
    </Configuration>

--------------------

# 4 Log4j2异步日志 #

> Log4j2最牛的地方在于异步输出日志时的性能表现；下图比较中Log4j2有三种模式：全局使用异步模式、部分Logger采用异步模式、异步Appender；可以看出在前两种模式下，Log4j2的性能较之Log4j和Logback有很大的优势

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70][] Log4j2在多线程的环境下吞吐量与Log4j和Logback比较图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 1][] 同步日志执行流程![20200419085947967.png][] 异步日志执行流程

> [https://logging.apache.org/log4j/2.x/performance.html][https_logging.apache.org_log4j_2.x_performance.html]
> 
> Log4j2提供了两种实现日志的方式，一个是通过AsyncAppender（了解即可），一个是通过AsyncLogger，分别对应Appender组件和Logger组件
> 
> 注意：配置异步日志需要添加依赖

<dependency>
        <groupId>com.lmax</groupId>
        <artifactId>disruptor</artifactId>
        <version>3.4.2</version>
    </dependency>

## 4.1 AsyncAppender方式（了解） ##

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="warn">
        <properties>
            <property name="LOG_HOME">F:/logs</property>
        </properties>
        <Appenders>
            <File name="file" fileName="${LOG_HOME}/log4j2.log">
                <PatternLayout>
                    <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
                </PatternLayout>
            </File>
            
            <Async name="fileAsync">
                <AppenderRef ref="file"/>
            </Async>
        </Appenders>
        <Loggers>
            <Root level="info">
                
                <AppenderRef ref="fileAsync"/>
            </Root>
        </Loggers>
    </Configuration>

## 4.2 AsyncLogger方式（重点） ##

> AsyncLogger才是log4j2 的重头戏，也是官方推荐的异步方式；它可以使得调用Logger.log返回的更快；你可以有两种选择：**全局异步**和**混合异步**

> **全局异步**就是，所有的日志都异步的记录，在配置文件上不用做任何改动，只需要添加一个log4j2.component.properties 配置

Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="debug">
        <properties>
            <property name="LOG_HOME">F:/logs</property>
        </properties>
        <Appenders>
            <Console name="console" target="SYSTEM_ERR">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36} %L %m%n" />
            </Console>
            <File name="file" fileName="${LOG_HOME}/log4j2.log">
                <PatternLayout>
                    <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
                </PatternLayout>
            </File>
        </Appenders>
        <Loggers>
            <Root level="info">
                <AppenderRef ref="console"/>
                <AppenderRef ref="file"/>
            </Root>
        </Loggers>
    </Configuration>

2020-04-19 09:26:41,906 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@18b4aac2,component=AsyncLoggerRingBuffer

> **混合异步**就是，你可以在应用中同时使用同步日志和异步日志，这使得日志的配置方式更加灵活

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="WARN">
        <properties>
            <property name="LOG_HOME">F:/logs</property>
            
            <property name="pattern" value="%d{HH:mm:ss.SSS} [%t] [%-5level] %c{36} %L %m%n"/>
        </properties>
        <Appenders>
            <Console name="console" target="SYSTEM_OUT">
                <PatternLayout pattern="${pattern}"/>
            </Console>
            <File name="file" fileName="${LOG_HOME}/log4j2.log">
                <PatternLayout>
                    <Pattern>${pattern}</Pattern>
                </PatternLayout>
            </File>
        </Appenders>
        <Loggers>
            
            <AsyncLogger name="com.nobug" level="trace" includeLocation="false" additivity="false">
                <AppenderRef ref="file"/>
                
            </AsyncLogger>
            <Root level="trace" includeLocation="true">
            </Root>
        </Loggers>
    </Configuration>

> 使用异步日志需要注意的问题：
> 
>  *  如果使用异步日志，AsyncAppender、AsyncLogger和全局日志，不要同时出现；性能会和 AsyncAppender一致，降至最低
>  *  设置includeLocation=false ，打印位置信息会急剧降低异步日志的性能，比同步日志还要慢

--------------------

# 5 Log4j2的性能 #

## 无垃圾记录 ##

> [https://logging.apache.org/log4j/2.x/manual/garbagefree.html][https_logging.apache.org_log4j_2.x_manual_garbagefree.html]
> 
> 垃圾收集暂停是延迟峰值的常见原因，并且对于许多系统而言，花费大量精力来控制这些暂停。
> 
> 许多日志库（包括以前版本的Log4j）在稳态日志记录期间分配临时对象，如日志事件对象，字符串， 字符数组，字节数组等。这会对垃圾收集器造成压力并增加GC暂停发生的频率。
> 
> 从版本2.6开始，默认情况下Log4j以“无垃圾”模式运行，其中重用对象和缓冲区，并且尽可能不分配临 时对象。还有一个“低垃圾”模式，它不是完全无垃圾，但不使用ThreadLocal字段。
> 
> Log4j 2.6中的无垃圾日志记录部分通过重用ThreadLocal字段中的对象来实现，部分通过在将文本转换 为字节时重用缓冲区来实现。

>  [https://www.jianshu.com/p/9f0c67facbe2][https_www.jianshu.com_p_9f0c67facbe2]

[https_logging.apache.org_log4j_2.x]: https://logging.apache.org/log4j/2.x/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70]: /images/20230521/1139c37c13384cf68351f71446485fa2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200419085809885.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzk0OTcz,size_16,color_FFFFFF,t_70
[20200419085947967.png]: /images/20230521/1030429a422845b3814d556d4332e876.png
[https_logging.apache.org_log4j_2.x_performance.html]: https://logging.apache.org/log4j/2.x/performance.html
[https_logging.apache.org_log4j_2.x_manual_garbagefree.html]: https://logging.apache.org/log4j/2.x/manual/garbagefree.html
[https_www.jianshu.com_p_9f0c67facbe2]: https://www.jianshu.com/p/9f0c67facbe2