springboot+log4j日志配置

已于 2023-03-29 15:55:41 修改
阅读量6.8k 收藏 4
点赞数
分类专栏： 日志框架 个人笔记 文章标签： spring boot java 后端
于 2021-11-04 16:58:29 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hauchun/article/details/121146288
版权

目录

1.log4j2配置

1.1 引入依赖

1.2 配置日志打印详细

2. 添加日志traceId

2.1 编写工具类

2.2 添加一个拦截器

2.3 添加配置

2.4 修改log4j2.yml日志配置

3.开启异步线程日志打印

3.1 引入依赖

3.2 JVM启动参数

3.3 验证是否开启异步日志打印

4. 常见问题

4.1 log4j2的配置不生效

日志是每个项目中必不可少的配置，主要用来运行情况和定位问题

以下为自己亲自测试的,如果大家有更好的方式，欢迎在下方留言！

1.log4j2配置

1.1 引入依赖

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

<dependency>  <!-- 支持识别yml配置 -->
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-yaml</artifactId>
</dependency>

1.2 配置日志打印详细

在resource目录下创建log4j2.yml文件

Appenders:
  Console:  #输出到控制台
    name: CONSOLE #Appender命名
    target: SYSTEM_OUT
    PatternLayout:
      pattern: "%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"
  RollingFile: # 输出到文件，超过256MB归档
    - name: ROLLING_FILE
      ignoreExceptions: false
      fileName: ./logs/hhmt-cpa.log
      filePattern: "./logs/$${date:yyyy-MM}/hhmt-cpa-%d{yyyy-MM-dd}-%i.log"
      PatternLayout:
        pattern: "%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"
      Policies:
        SizeBasedTriggeringPolicy:
          size: "10 KB"
      DefaultRolloverStrategy:
        max: 1000
Loggers:
  Root:
    level: info
    AppenderRef:
      - ref: CONSOLE
  Logger: #单独设置某些包的输出级别
    - name: com.hhmt.delivery #复数加上-（这里我设置的是包的根路径的包名）
      additivity: false #去除重复的log
      level: info
      AppenderRef:
        - ref: CONSOLE #复数加上-
        - ref: ROLLING_FILE #复数加上-

效果展示

如果想要尝试更加详细的可以使用这个：

#log4j 配置
#log4j定义了8个级别的log优先级从高到低依次为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。
#CONSOLE前面的DEBUG是控制台需要打印什么DEBUG级别以上的日志的信息
#log4j.rootLogger=DEBUG, CONSOLE, ERROR, WARN, INFO, DEBUG, ALL
log4j.rootLogger= DEBUG, CONSOLE, ERROR, WARN, INFO, DEBUG, ALL
#-----------------------------------------------------------------------------------------------------
#输出信息到控制台CONSOLE
log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.Target = System.out
log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
#-----------------------------------------------------------------------------------------------------
#输出ERROR 级别以上的日志到error.log
log4j.logger.ERROR=ERROR
log4j.appender.ERROR = org.apache.log4j.DailyRollingFileAppender
log4j.appender.ERROR.File =logs/error/error.log
log4j.appender.file.DatePattern ='.'yyyy-MM-dd
log4j.appender.ERROR.Threshold = ERROR
log4j.appender.ERROR.Append = true
log4j.appender.ERROR.layout = org.apache.log4j.PatternLayout
log4j.appender.ERROR.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#-----------------------------------------------------------------------------------------------------
#输出WARN 级别以上的日志到warn.log
log4j.logger.WARN=WARN
log4j.appender.WARN = org.apache.log4j.DailyRollingFileAppender
log4j.appender.WARN.File =logs/warn/warn.log
log4j.appender.file.DatePattern ='.'yyyy-MM-dd
log4j.appender.WARN.Threshold = WARN
log4j.appender.WARN.Append = true
log4j.appender.WARN.layout = org.apache.log4j.PatternLayout
log4j.appender.WARN.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#-----------------------------------------------------------------------------------------------------
#输出INFO级别以上的内容到info.log中  info日志每100MB创建一个新文件
log4j.logger.INFO=INFO
log4j.appender.INFO = org.apache.log4j.RollingFileAppender 
log4j.appender.ROLLING_FILE.MaxFileSize=100MB 
log4j.appender.INFO.File = logs/info/info.log
#log4j.appender.file.DatePattern ='.'yyyy-MM-dd
log4j.appender.INFO.Threshold = INFO
log4j.appender.INFO.Append = true
log4j.appender.INFO.layout = org.apache.log4j.PatternLayout
log4j.appender.INFO.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#-----------------------------------------------------------------------------------------------------
#输出DEBUG 级别以上的日志到debugger.log
log4j.logger.DEBUG=DEBUG
log4j.appender.DEBUG = org.apache.log4j.RollingFileAppender
log4j.appender.ROLLING_FILE.MaxFileSize=100MB 
log4j.appender.DEBUG.File = logs/debugger/debugger.log
#log4j.appender.file.DatePattern ='.'yyyy-MM-dd
log4j.appender.DEBUG.Threshold = DEBUG
log4j.appender.DEBUG.Append = true
log4j.appender.DEBUG.layout = org.apache.log4j.PatternLayout
log4j.appender.DEBUG.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#-----------------------------------------------------------------------------------------------------
#输出ALL级别的日志到all.log
log4j.logger.ALL=ALL
log4j.appender.ALL = org.apache.log4j.RollingFileAppender
log4j.appender.ROLLING_FILE.MaxFileSize=100MB 
log4j.appender.ALL.File = logs/all/all.log
#log4j.appender.file.DatePattern ='.'yyyy-MM-dd
log4j.appender.ALL.Threshold = ALL
log4j.appender.ALL.Append = true
log4j.appender.ALL.layout = org.apache.log4j.PatternLayout
log4j.appender.ALL.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#-----------------------------------------------------------------------------------------------------

原文参考：【亲测有用】springboot + log4j2 日志按天并且按大小切割_u013282737的博客-CSDN博客_springboot 日志切割

2. 添加日志traceId

在传统系统中，如果能够提供日志输出，基本上已经能够满足需求的。但一旦将系统拆分成两套及以上的系统，再加上负载均衡等，调用链路就变得复杂起来。

特别是进一步向微服务方向演化，如果没有日志的合理规划、链路追踪，那么排查日志将变得异常困难。

比如系统A、B、C，调用链路为A -> B -> C，如果每套服务都是双活，则调用路径有2的三次方种可能性。如果系统更多，服务更多，调用链路则会成指数增长。

因此，无论是几个简单的内部服务调用，还是复杂的微服务系统，都需要通过一个机制来实现日志的链路追踪。让你系统的日志输出，像诗一样有形式美，又有和谐的韵律。

日志追踪其实已经有很多现成的框架了，比如Sleuth、Zipkin等组件。但这不是我们要讲的重点，本文重点基于Spring Boot、LogBack来手写实现一个简单的日志调用链路追踪功能。基于此实现模式，大家可以更细粒度的去实现。

2.1 编写工具类

package com.huachun.utils;

import java.util.UUID;

public class TraceIdUtils {

    private static final ThreadLocal<UUID> requestIdHolder = new ThreadLocal<>();

    private TraceIdUtils() {
    }

    /**
     * 生成traceId
     *
     * @return TraceId 基于UUID
     */
    public static String getTraceId() {
        return UUID.randomUUID().toString().replace("-", "");
    }

    public static void generateRequestId() {
        requestIdHolder.set(UUID.randomUUID());
    }

    public static void generateRequestId(UUID uuid) {
        requestIdHolder.set(uuid);
    }

    public static UUID getRequestId() {
        return (UUID) requestIdHolder.get();
    }

    public static void removeRequestId() {
        requestIdHolder.remove();
    }
}

package com.huachun.utils;

import org.slf4j.MDC;
import org.springframework.util.StringUtils;

public class TraceIdContext {

    public static final String TRACE_ID_KEY = "requestId";

    public static void setTraceId(String traceId) {
        if (!StringUtils.isEmpty(traceId)) {
            MDC.put(TRACE_ID_KEY, traceId);
        }
    }

    public static String getTraceId() {
        String traceId = MDC.get(TRACE_ID_KEY);
        return traceId == null ? "" : traceId;
    }

    public static void removeTraceId() {
        MDC.remove(TRACE_ID_KEY);
    }

    public static void clearTraceId() {
        MDC.clear();
    }

}

2.2 添加一个拦截器

package com.huachun.filter;

import com.huachun.utils.TraceIdUtils;
import com.huachun.utils.TraceIdContext;
import org.springframework.util.StringUtils;
import org.springframework.web.filter.AbstractRequestLoggingFilter;

import javax.servlet.http.HttpServletRequest;

public class TraceIdRequestLoggingFilter extends AbstractRequestLoggingFilter {
    @Override
    protected void beforeRequest(HttpServletRequest request, String message) {
        String requestId = request.getHeader(TraceIdContext.TRACE_ID_KEY);
        if (!StringUtils.isEmpty(requestId)) {
            TraceIdContext.setTraceId(requestId);
        } else {
            TraceIdContext.setTraceId(TraceIdUtils.getTraceId());
        }
    }

    @Override
    protected void afterRequest(HttpServletRequest request, String message) {
        TraceIdContext.removeTraceId();
    }
}

2.3 添加配置

package com.huachun.config;

import com.huachun.filter.TraceIdRequestLoggingFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class TraceIdConfig {

    @Bean
    public TraceIdRequestLoggingFilter traceIdRequestLoggingFilter() {
        return new TraceIdRequestLoggingFilter();
    }
}

2.4 修改log4j2.yml日志配置

Appenders:
  Console:  #输出到控制台
    name: CONSOLE #Appender命名
    target: SYSTEM_OUT
    PatternLayout:
      pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS}:%4p [%t] [%X{requestId}] (%logger{36}:%L) - %m%n"

  RollingFile: # 输出到文件，超过256MB归档
    - name: ROLLING_FILE
      ignoreExceptions: false
      fileName: ./log_demo/log_demo.log
      filePattern: "./log_demo/$${date:yyyy-MM}/log_demo-%d{yyyy-MM-dd}-%i.log"
      PatternLayout:
        pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS}:%4p [%t] [%X{requestId}] (%logger{36}:%L) - %m%n"
      Policies:
        SizeBasedTriggeringPolicy:
          size: "52 MB"
      DefaultRolloverStrategy:
        max: 1000
Loggers:
  Root:
    level: info
    AppenderRef:
      - ref: CONSOLE
  Logger: #单独设置某些包的输出级别
    - name: org.huachun #复数加上-（这里我设置的是包的根路径的包名）
      additivity: false #去除重复的log
      level: info
      AppenderRef:
        - ref: CONSOLE #复数加上-
        - ref: ROLLING_FILE #复数加上-

主要替换了原有的输出格式

pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS}:%4p [%t] [%X{requestId}] (%logger{36}:%L) - %m%n"

在value属性的表达式中，我们新增了自定义的变量值requestId，通过“[%X{requestId}]”的形式来展示。

这个requestId便是我们用来追踪日志的唯一标识。如果一个请求，从头到尾都使用了同一个requestId便可以把整个请求链路串联起来。如果系统还基于EKL等日志搜集工具进行统一收集，就可以更方便的查看整个日志的调用链路了。

参考原文：基于SpringBoot实现让日志像诗一样有韵律（日志追踪）_程序新视界的博客-CSDN博客_springboot 日志追踪框架

3.开启异步线程日志打印

3.1 引入依赖

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

3.2 JVM启动参数

需要添加在JVM启动参数的地方

-DLog4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

错误的方式：

System.setProperty("Log4jContextSelector", "org.apache.logging.log4j.core.async.AsyncLoggerContextSelector");

3.3 验证是否开启异步日志打印

 

原文参考： Springboot配置log4j2异步输出日志_强哥叨逼叨的博客-CSDN博客

4. 常见问题

4.1 log4j2的配置不生效

问题描述：参照上面的配置，在其他项目中是可以正常输出配置格式的日志，但是到了另一个项目就无法正常输出了

但是在另一个项目中始终无法正确输出配置的格式

问题原因：

解决办法： 

春卷-huachun
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
springboot+mybatis+log4j2
05-29
Log4j2提供了灵活的日志配置，支持多种日志格式，如文本、JSON、XML等，并且具备强大的日志级别控制、异步日志记录、过滤器、插件体系等功能。相较于Spring Boot默认的日志系统Logback，Log4j2提供了更多的可定制...
springboot项目使用log4j2，日志配置文件log4j2.xml的使用说明及个人注意点总结
刘大猫
10-31 5971
springboot项目使用log4j2，日志配置文件log4j2.xml的使用说明及个人注意点总结
Springboot配置Log4j
郝南过的博客
11-07 6710
springboot配置log4j
Spring boot集成log4j及日志配置详解，实战，ELK使用教程。
Java码农杂谈
06-13 1614
详细介绍了如何在 SpringBoot 项目中集成 Log4j 以及 Log4j 配置文件的各种配置方法。通过合理地配置日志系统，我们能够更好地进行故障排查、性能监控和安全审计。进一步地，通过日志数据采集和分析工具，我们能够实现对日志数据的深度挖掘，为我们的应用提供了更便捷的数据可视化等支持。
Springboot集成log4j
热门推荐
xiaoguangtouqiang的博客
01-13 1万+
log4j在项目中应该是使用的最多的日志框架了，一直没有好好去深入总结下，这篇文章记录下一些常规的用法； 1.集成 引入依赖，如下所示： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> &lt...
SpringBoot整合Log4j
z_beast的博客
12-07 925
SpringBoot整合Log4j 添加依赖 因为在Spring boot当中有了Logback进行日志记录，所以需要先将Logback剔除 <dependencies> <dependency> <groupId>org.springframework.boot</groupId> ...
log4j配置文件
lucasmaluping的专栏
10-15 891
添加依赖： <!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2....
SpringBoot如何配置log4j输出日志呢？
qq_25073223的博客
11-21 5063
SpringBoot配置log4j输出日志的方法分享
springboot+swagger3+mybatis-plus3.5.1代码生成+druid+log4j2【最完美】的一次配置
12-21
在SpringBoot中集成Log4j2，我们需要在资源目录下创建log4j2.xml或log4j2.json配置文件，定义日志级别、输出格式和目的地。 这个"template-master"可能是项目模板，包含了一个完整的配置示例。在这个模板中，你可能...
SpringBoot第 3 讲：SpringBoot+Junit+Log4J
10-10
在本讲中，我们将深入探讨如何在SpringBoot项目中整合JUnit测试框架以及Log4J日志系统。SpringBoot简化了Java应用的开发流程，而JUnit是广泛使用的单元测试工具，Log4J则是一款强大的日志记录框架。让我们一起了解...
SpringBoot+Swagger3+log4j2
11-12
在IT行业中，SpringBoot、Swagger3和log4j2是三个非常重要的工具和技术，它们各自在不同的领域发挥着关键作用。下面将详细解释这三个技术及其整合应用。 **SpringBoot** SpringBoot是由Pivotal团队提供的一个Java...
SpringBoot2.X整合Mybatis代码示例2-使用配置文件方式+Log4j
09-17
总结，通过上述步骤，我们已经成功地在SpringBoot 2.x项目中整合了Mybatis，并配置了Log4j进行日志记录。这样，不仅能够方便地进行数据库操作，还能通过日志跟踪程序运行状态，对问题定位和调试提供帮助。在实际开发...
SpringBoot中使用log4j进行日志管理
BADAO_LIUMANG_QIZHI的博客
03-29 2054
场景 SpringBoot项目中使用log4j进行日志管理。 实现 1.因为SpringBoot默认是使用logback，所以要修改pom.xml 过滤掉自带的spring-boot-starter-logging,然后添加spring-boot-starter-log4j依赖包。 <!-- log4j --> <dependency> <g...
springboot 使用 log4j
张小三的博客
05-25 5631
1.在pom.xmlz中移除springboot中对logback依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <!--移除框架中的logback依赖--> <exclusion&g
springboot中如何使用log4j
cai_niao5623的博客
04-01 2916
2、创建log4j.properties文件。1、引入依赖(pom.xml)
Springboot配置Log4j日志系统，并将日志存入数据库
周彰健的博客
06-09 3942
Log4j是apache公司开发的一款日志管理系统，可以高效的管理系统中出现的BUG或者各种信息，并且可以已文本的方式或者数据库存入的方式来记录数据。
Springboot配置log4j2配置文件和log4j2.xml详解
蓝天⊙白云的博客
07-05 8585
最近由于项目的需要，我们把log4j 1.x的版本全部迁移成log4j 2.x 的版本，那随之而来的slf4j整合log4j的配置（使用Slf4j集成Log4j2构建项目日志系统的完美解决方案）以及log4j2配置文件的详解，就需要我们来好好聊一聊了。本文就专门来讲解下log4j2.xml配置文件的各项标签的意义。 一、Springboot依赖 （1）剔除spring web包含的依赖 <dependency> <groupId>org.springframework.boo
SpringBoot——log4j日志配置
梦里逆天的博客
12-17 427
在创建Spring Boot工程时，引入了spring-boot-starter，其中包含了spring-boot-starter-logging，即Spring Boot默认的日志框架Logback，所以在引入log4j之前，需要先排除该包的依赖，再引入log4j的依赖： 一、引入log4j依赖 <!-- 忽略自带的日志框架. --> <dependency> &l...
SpringBoot配置日志(log4j版)
孙霸天的专栏
03-25 4029
SpringBoot配置日志(log4j版) 介绍 在软件开发中，日志是个很重要的东西，它记录系统中方法运行的过程信息和系统报错时的错误信息。开发人员在排查系统中的错误，就可以通过错误日志来进行排查，如果没有日志那排查错误得发疯。。。 在SpringBoot版本2.X.X以后，SpringBoot就将log4j设置为默认的日志框架了。 后面我将介绍SpringBoot中如何设置log4j，好好保存日志，是我们必须的。 这里的日志指的就是我们在控制台中看到的信息，如图所示： Log4j简介 Log4j有三个
springboot+log4j2
最新发布
06-26
Spring Boot 是一个流行的开源框架，它简化了构建独立、生产级的Java应用程序的过程。它与 Log4j 2 结合使用，提供了一种强大的日志管理解决方案。 **Spring Boot + Log4j2 的简介：** 1. **集成简单**：Spring Boot 内置对 Log4j 2 的支持，无需额外配置即可启用日志记录。只需添加依赖，就可以开始使用 Log4j2 的功能。 2. **配置灵活**：Log4j2 提供丰富的配置选项，包括不同的布局（如 JSON、XML 或 YAML），可以根据项目需求定制日志格式和级别。 3. **异步处理**：Spring Boot 的整合使得日志可以异步处理，这有助于提高应用性能，尤其是在高并发环境下。 4. **日志事件驱动**：Log4j2 支持事件驱动模型，可以方便地处理日志的过滤、路由和复杂操作。 **具体步骤**： - 在pom.xml或build.gradle文件中添加Log4j2的依赖。 - 配置Log4j2的主配置文件，通常在src/main/resources目录下的log4j2.xml或application.yml。 - 使用`@Slf4j`或`logging.level.<package>=<level>`注解来控制特定包的日志级别。 **相关问题--:** 1. Spring Boot 如何简化Log4j2的集成？ 2. Log4j2有哪些主要的配置文件和它们的作用是什么？ 3. 在Spring Boot中如何设置全局的日志级别？ 4. Spring Boot如何利用Log4j2实现异步日志处理？
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值