springboot 集成log4j2 ，同步日志和异步日志

最新推荐文章于 2024-06-04 11:41:50 发布

无、涯

最新推荐文章于 2024-06-04 11:41:50 发布

阅读量2.1k

点赞数

分类专栏： log4j2 springboot 文章标签： springboot log4j2 同步异步日志 AsyncAppender AsyncLogger

本文链接：https://blog.csdn.net/a704397849/article/details/98499254

版权

springboot 同时被 2 个专栏收录

63 篇文章 3 订阅

订阅专栏

log4j2

5 篇文章 0 订阅

订阅专栏

参考

https://www.cnblogs.com/yeyang/p/7944906.html 同步日志和异步日志
https://blog.csdn.net/RyanDon/article/details/82589989
https://www.jianshu.com/p/5dcf4ece0de3

log4j2 依赖 spring-boot-starter-log4j2

注意，spring-boot-starter自带日志依赖，需要用 exclusion 排除掉

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        
        <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>

log4j2 的 springboot默认配置

如果没有配置log4j2的话，log4j2会有默认配置，默认将info及以上级别的日志同步输出到控制台，如下：
在这里插入图片描述

    public final static Logger logger = LoggerFactory.getLogger(UserController.class);

    @RequestMapping("/test")
    public String addUser() {
        //参数 string
        logger.trace("trace level");
        logger.debug("debug level");
        logger.info("info level");
        logger.warn("warn level");
        logger.error("error level");

        //格式化生成message , 占位符 {}
        logger.info("1 + {} + 3 = {}" ,2,"6");

        //输出异常信息
        logger.info("异常信息：",new Exception("hhhhhhhhhhhhhhh"));
        return  "";
    }

控制台输出结果
2019-08-05 17:42:45.666  INFO 3564 --- [nio-8096-exec-1] c.e.l.c.UserController                   : info level
2019-08-05 17:42:45.666  WARN 3564 --- [nio-8096-exec-1] c.e.l.c.UserController                   : warn level
2019-08-05 17:42:45.666 ERROR 3564 --- [nio-8096-exec-1] c.e.l.c.UserController                   : error level
2019-08-05 17:42:45.667  INFO 3564 --- [nio-8096-exec-1] c.e.l.c.UserController                   : 1 + 2 + 3 = 6
2019-08-05 17:42:45.667  INFO 3564 --- [nio-8096-exec-1] c.e.l.c.UserController                   : 异常信息：

java.lang.Exception: hhhhhhhhhhhhhhh
	at com.example.log4j2_demo.controller.UserController.addUser(UserController.java:27) [classes/:?]
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[?:1.8.0_201]
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[?:1.8.0_201]
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[?:1.8.0_201]
	at java.lang.reflect.Method.invoke(Method.java:498) ~[?:1.8.0_201]
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:190) [spring-web-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:138) [spring-web-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:104) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:892) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:797) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1039) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:942) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1005) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:897) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:634) [tomcat-embed-core-9.0.21.jar:9.0.21]
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:882) [spring-webmvc-5.1.8.RELEASE.jar:5.1.8.RELEASE]
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:741) [tomcat-embed-core-9.0.21.jar:9.0.21]

log4j2 的 xml配置,大致如下：

Configuration
- properties
- Appenders
  - Console
    - PatternLayout
  - File
    - PatternLayout
  - RollingRandomAccessFile
  - Async (Async Appender异步，内部采用ArrayBlockingQueue)
    - AppenderRef 指定具体哪个Appender采用Async Appender异步
- Loggers
  - Root
    - AppenderRef
  - Logger
    - AppenderRef
  - AsyncLogger (Async Logger异步，采用了高性能并发框架Disruptor，高性能)
    - appender-ref 指定具体哪个Appender采用Async Logger异步

同步log4j2 xml配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <properties>
        <property name="LOG_HOME">../logs</property>
        <property name="FILE_NAME">mylog</property>
        <property name="log.sql.level">info</property>
    </properties>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">  
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n" />  
        </Console>
        <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="20"/>
        </RollingRandomAccessFile>
    </Appenders>
    <Loggers>
        <Root level="info">  
            <AppenderRef ref="Console" />  
            <AppenderRef ref="RollingRandomAccessFile" />  
        </Root>
        <Logger name="com.mengdee.dao" level="${log.sql.level}" additivity="false">
            <AppenderRef ref="Console" />
        </Logger>
    </Loggers>
</Configuration>

log4j2配置介绍

Configuration：为根节点，有status和monitorInterval等多个属性
- status的值有 “trace”, “debug”, “info”, “warn”, “error” and “fatal”，用于控制log4j2日志框架本身的日志级别，如果将stratus设置为较低的级别就会看到很多关于log4j2本身的日志，如加载log4j2配置文件的路径等信息
  注意：这个属性是针对框架本身信息，不针对我们用logger输出的信息.
- monitorInterval，含义是每隔多少秒重新读取配置文件，可以不重启应用的情况下修改配置
properties: 属性
使用来定义常量，以便在其他配置的时候引用，该配置是可选的，例如定义日志的存放位置 …/logs
Appenders：输出源，用于定义日志输出的地方
log4j2支持的输出源有很多，有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume 等
- Console：控制台输出源是将日志打印到控制台上，开发的时候一般都会配置，以便调试
- File：文件输出源，用于将日志写入到指定的文件，需要配置输入到哪个位置（例如：D:/logs/mylog.log）
- RollingRandomAccessFile: 该输出源也是写入到文件，不同的是比File更加强大，可以指定当文件达到一定大小（如20MB）时，另起一个文件继续写入日志，另起一个文件就涉及到新文件的名字命名规则，因此需要配置文件命名规则
  这种方式更加实用，因为你不可能一直往一个文件中写，如果一直写，文件过大，打开就会卡死，也不便于查找日志。
  - fileName 指定当前日志文件的位置和文件名称
  - filePattern 指定当发生Rolling时，文件的转移和重命名规则
  - SizeBasedTriggeringPolicy 指定当文件体积大于size指定的值时，触发Rolling
  - DefaultRolloverStrategy 指定最多保存的文件个数
  - TimeBasedTriggeringPolicy 这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i，最小的时间粒度是mm，即分钟
  - TimeBasedTriggeringPolicy指定的size是1，结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，则每一个小时生成一个文件
  - PatternLayout：控制台或文件输出源（Console、File、RollingRandomAccessFile）都必须包含一个PatternLayout节点，用于指定输出文件的格式（如日志输出的时间文件方法行数等格式），例如 pattern=”%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n”
```
  %d{HH:mm:ss.SSS} 表示输出到毫秒的时间
  %t 输出当前线程名称
  %-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
  %logger 输出logger名称，因为Root Logger没有名称，所以没有输出
  %msg 日志文本
  %n 换行

  其他常用的占位符有：
  %F 输出所在的类文件名，如Log4j2Test.java
  %L 输出行号
  %M 输出所在方法名
  %l 输出语句所在的行数, 包括类名、方法名、文件名、行数
```
- NoSql：MongoDb, 输出到MongDb数据库中
- Flume：输出到Apache Flume（Flume是Cloudera提供的一个高可用的，高可靠的，分布式的海量日志采集、聚合和传输的系统，Flume支持在日志系统中定制各类数据发送方，用于收集数据；同时，Flume提供对数据进行简单处理，并写到各种数据接受方（可定制）的能力。）
- Async：异步，需要通过AppenderRef来指定要对哪种输出源进行异步（一般用于配置RollingRandomAccessFile）
Loggers：日志分根器
日志器分根器 : Root和自定义日志器，当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器，自定义时需要指定每个Logger的名称name（对于命名可以以包名作为日志的名字，不同的包配置不同的级别等），日志级别level，相加性additivity（是否继承下面配置的日志器），对于一般的日志器（如Console、File、RollingRandomAccessFile）一般需要配置一个或多个输出源AppenderRef；

每个logger可以指定一个level（TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF），不指定时level默认为ERROR

additivity指定是否同时输出log到父类的appender，缺省为true。

Async Appender异步 log4j2 xml配置举例如下:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
  <Appenders>
    <RollingFile name="MyFile" fileName="logs/app.log">
      <PatternLayout>
        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
      </PatternLayout>
      <SizeBasedTriggeringPolicy size="500MB"/>
    </RollingFile>
    <Async name="Async">
      <AppenderRef ref="MyFile"/>
    </Async>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Async"/>
    </Root>
  </Loggers>
</Configuration>

上面就是一个使用AsyncAppender的典型配置，配置AsyncAppender后，日志事件写入文件的操作将在单独的线程中执行
AsyncAppender的常用参数

参数名	类型	说明
name	String	Async Appender的名字。
AppenderRef	String	异步调用的Appender的名字，可以配置多个。
blocking	boolean	默认为true。如果为true，appender将一直等待直到queue中有空闲；如果为false，当队列满的时候，日志事件将被丢弃。(如果配置了error appender，要丢弃的日志事件将由error appender处理)
bufferSize	integer	队列中可存储的日志事件的最大数量，默认为128。(源码中为128，Log4j2官网为1024，官网信息有误)

关于AsyncAppender的其他参数，可参考Log4j2对AsyncAppender的详细介绍。

每个Async Appender，内部维护了一个ArrayBlockingQueue，并将创建一个线程用于输出日志事件，如果配置了多个AppenderRef，将分别使用对应的Appender进行日志输出。

AsyncLogger 异步 log4j2 xml配置举例如下:

Log4j2中的AsyncLogger的内部使用了Disruptor框架。


<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="debug" name="MyApp" packages="">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <RollingFile name="RollingFile" fileName="logs/app.log"
                     filePattern="logs/app-%d{yyyy-MM-dd HH}.log">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="500MB"/>
            </Policies>
        </RollingFile>
        <RollingFile name="RollingFile2" fileName="logs/app2.log"
                     filePattern="logs/app2-%d{yyyy-MM-dd HH}.log">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="500MB"/>
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
        <AsyncLogger name="com.meituan.Main" level="trace" additivity="false">
            <appender-ref ref="RollingFile"/>
        </AsyncLogger>
        <AsyncLogger name="RollingFile2" level="trace" additivity="false">
            <appender-ref ref="RollingFile2"/>
        </AsyncLogger>
        <Root level="debug">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="RollingFile"/>
        </Root>
    </Loggers>
</Configuration>

java代码使用上面配置的log4j2,输出日志信息


public class Main {
    public static void main(String args[]) {
        Logger logger = LogManager.getLogger(Main.class);
        Logger logger2 = LogManager.getLogger("RollingFile2");
 
        Person person = new Person("Li", "lei");
        logger.info("hello, {}", person);
        logger2.info("good bye, {}", person);
}

上述log4j2.xml中配置了两个AsyncLogger，名字分别为com.meituan.Main和RollingFile2。
并且，在main方法中分别使用两个logger来输出两条日志。

在加载log4j2.xml的启动阶段，如果检测到配置了AsyncRoot或AsyncLogger，将启动一个disruptor实例。

配置对应的输出方式

配置	日志输出方式
sync	同步打印日志，日志输出与业务逻辑在同一线程内，当日志输出完毕，才能进行后续业务逻辑操作
Async	异步打印日志，内部采用ArrayBlockingQueue，对每个AsyncAppender创建一个线程用于处理日志输出。
AsyncLogger	异步打印日志，采用了高性能并发框架Disruptor，创建一个线程用于处理日志输出。

各种配置的性能

吞吐量测试
平均耗时

无、涯

关注

0
点赞
踩
7

收藏

觉得还不错? 一键收藏
0
评论
springboot 集成log4j2 ，同步日志和异步日志

参考https://www.cnblogs.com/yeyang/p/7944906.html 同步日志和异步日志https://blog.csdn.net/RyanDon/article/details/82589989https://www.jianshu.com/p/5dcf4ece0de3log4j2 依赖 spring-boot-starter-log4j2注意，sprin...
复制链接

扫一扫