logback + MDC 搭建 springboot 的日志系统

已于 2022-12-01 17:39:38 修改
阅读量2.3k 收藏 5
点赞数
分类专栏： 后端 文章标签： logback spring boot java mdc
于 2020-09-14 20:21:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qingquanyingyue/article/details/108586549
版权
前言：

日志的作用是什么？调试，问题定位，数据分析。日志很重要，要保证统一的样式，分级别，请求可追溯。

1. springboot 自带的logback

如果你是 ieda 开发工具，并且是maven工程，
可以点开 pom 文件，右键 -> maven -> Show Dependencies ，可以查看整个项目的依赖关系，其中有 logback
logback

2.配置 logback.xml 文件

这个文件配置好放在 resources 目录下即可（不需要其他任何地方的配置），工程可自动识别，仔细阅读文件注解。

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--每个logger都关联到logger上下文，默认上下文名称为“default”,用于区分不同应用程序的记录。一旦设置，不能修改 -->
    <contextName>${APP_NAME}</contextName>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="./logs" />
    <property name="APP_NAME" value="log"/>
    <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
    <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{requestId}]  %-5level %logger{50} - %msg%n"/>

    <!-- 控制台输出 -->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="fileInfoLog"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/${APP_NAME}.info.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
            <!-- totalSizeCap:该类文件最大空间，超过后会删除而不会管是否在保存时间内 -->
            <totalSizeCap>30MB</totalSizeCap>
            <!--  是否启动时清理过期日志，默认false  -->
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="fileErrorLog"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/${APP_NAME}.error.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>10</MaxHistory>
            <!-- totalSizeCap:该类文件最大空间，超过后会删除而不会管是否在保存时间内 -->
            <totalSizeCap>8MB</totalSizeCap>
            <!--  是否启动时清理过期日志，默认false  -->
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="fileWarnLog"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/${APP_NAME}.warn.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>10</MaxHistory>
            <!-- totalSizeCap:该类文件最大空间，超过后会删除而不会管是否在保存时间内 -->
            <totalSizeCap>8MB</totalSizeCap>
            <!--  是否启动时清理过期日志，默认false  -->
            <cleanHistoryOnStart>true</cleanHistoryOnStart>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="fileDebugLog"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/${APP_NAME}.debug.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>10</MaxHistory>
            <totalSizeCap>1MB</totalSizeCap>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="consoleLog" />
        <appender-ref ref="fileErrorLog" />
        <appender-ref ref="fileInfoLog"/>
        <appender-ref ref="fileWarnLog" />
        <appender-ref ref="fileDebugLog" />
    </root>
</configuration>
3.写个controller 测试一下

日志记录用的是 lombok 里面的小插件，也可以使用其他的。

@RestController
@Slf4j
public class LogController {
    @GetMapping("/search")
    public Object getInfo(
            @RequestParam(value = "keyword", required = false) String keyword) {
        String error = "这是error级别log";
        log.error("this is error log,{}", error);

        String warn = "这是warn级别log";
        log.warn("this is warn log,{}", warn);

        String info = "这是info级别log";
        log.info("this is info log,{}", info);

        Map<String, String> response = new HashMap<>();
        response.put("requestId", RequestIdUtil.getRequestId());  // 这块下面讲
        response.put("body", "body");

        return response;

    }
}

在服务器上运行以后可以发现在当前目录下生成 log 文件夹，里面有4个级别的log文件，如下
日志级别文件

4.增加请求可追溯功能

在步骤 2 和 3 里面都有一个关键词 requestId，它的作用是给每次请求加一个唯一标识，这样请求在系统流转就会带着这个唯一id打印日志，定位问题和分析很有用。

  1. 主流方式是MDC，有兴趣的可以查一下，这里直接贴代码
  2. 先写一个类用于操作MDC
import org.slf4j.MDC;
import java.util.UUID;


public class RequestIdUtil {
    public static final String REQUEST_ID = "requestId";

    public static void setRequestId() {
        MDC.put(REQUEST_ID, UUID.randomUUID().toString());
    }


    public static String getRequestId() {
        return MDC.get(REQUEST_ID);
    }

    public static void clear() {
        MDC.clear();
    }
}
  1. 再写一个过滤器，用于记录每次请求
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Component
public class RequestIdFilter implements Filter {

    private static final String REQUEST_ID_HEADER = "RequestId";

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        RequestIdUtil.setRequestId();   // 这行是核心
		HttpServletResponse httpResponse = (HttpServletResponse) servletResponse;
        String requestId = RequestIdUtil.getRequestId();
        httpResponse.setHeader(REQUEST_ID_HEADER, requestId);  // 把请求id写到响应头里面
        try {
            filterChain.doFilter(servletRequest, servletResponse);
        } finally {
            RequestIdUtil.clear();
        }
    }
}
  1. 测试

看一下步骤 3 的返回结果

{"requestId":"651a0b9b-1691-4fb2-a95f-e37275ee19e9","body":"body"}

查看一下日志内容：

2020-09-14 20:06:39.997 [http-nio-8088-exec-1] [651a0b9b-1691-4fb2-a95f-e37275ee19e9]  INFO  log.test.controller.LogController - this is info log,这是info级别log
5 参考文档

花了 20 分钟写的代码，比较粗糙，想了解更多的可以参考下面文档

  1. springboot超级详细的日志配置(基于logback)
  2. SpringBoot Logback日志配置
  3. 在SpringBoot项目中添加logback的MDC
  4. SpringBoot+MDC实现全链路调用日志跟踪，排查问题更方便
清泉影月
关注
专栏目录
spring-boot 将logback和MDC集成
u011877502的博客
01-13 722
因为公司业务需要，需要把性能日志和业务日志分开打印，用elk收集处理，所以需要对不同的业务的日志，打印到不同文件。 使用的是spring boot自带的logback。 首先在yml文件配置logback.xml文件，默认会从resources下找logback.xml文件，找不到会从yml文件中找logging.config下的指定文件。 logging: level: DEB...
MySql+SpringBoot+Vue 搭建一个完整的前后端分离项目
weixin_44062380的博客
04-16 7148
完整项目搭建流程 虽说 SpringBoot 相较于 SSM 框架，大大减轻了配置的繁琐，但是，要整合 MyBatis ，统一异常处理，Vue等一系列东西，还是要费一番劲的。 这次将创建的整个流程记录下来，方便以后的项目搭建。 要搭建一个完成的前后端分离项目，分为这么几个部分：数据库、后端、前端 如果是为微信小程序搭建一个后端服务，那就只要看到数据库、后端就可以了 数据库 一般在新建项目的时候，我们会选择专门为这个项目新建一个用户，并为这个用户，赋予只属于这一个项目的所有权限 1. 连接 admin 只有
MDC 输出日志加上参数
qq56477643的博客
02-19 448
【代码】MDC 输出日志加上参数。
Logback日志框架之使用MDC动态变量根据业务、接口、任务生成相应日志文件
最新发布
积跬步，至千里。
07-24 1169
在Logback日志框架中，使用MDC可以为每个线程关联一些上下文信息，在日志输出时可以包含这些信息，从而区分不同线程的日志输出。
SpringBoot logback 的 MDC
h_sn9999的专栏
01-13 996
Logback的设计目标就是审计、调试复杂的分布式应用。 在分布式应用中，为了区分不同客户端的日志输出，往往为每个客户端实例化一个单独的logger。但是这样将导致大量日志的产生，而且增加了日志管理的负担。 为此，Logback采用了更轻量级的技术，为一个客户端的每一个日志请求打上唯一识别的时间戳，而这是通过SLF4J的MDC实现的。为了给每个日志请求打上唯一识别的时间戳，必须利用请求的上下文...
springboot集成logback+MDC
qq_43755434的博客
04-19 888
<?xml version="1.0" encoding="UTF-8"?> <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 --> <!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true --> <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默
SpringBoot+MDC+logback实现日志格式化输出
Congee_porridge的博客
06-19 1806
使用SpringBoot+MDC+logback实现日志格式化输出，在aop切面进行操作，针对异步线程、跨服务调用，父子线程值的传递进行处理
logback mdc
东境物语
10-12 708
logback内置的日志字段还是比较少，如果我们需要打印有关业务的更多的内容，包括自定义的一些数据，需要借助logback MDC机制，MDC为“Mapped Diagnostic Context”（映射诊断上下文），即将一些运行时的上下文数据通过logback打印出来；此时我们需要借助org.sl4j.MDC类。 MDC类基本原理其实非常简单，其内部持有一个InheritableT
建立logback.xml 配合MDC 实现追踪
weixin_30426957的博客
07-03 238
<?xml version="1.0" encoding="UTF-8"?> <configuration debug="false"> <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径--> <property name="LOG_HOME" value="./logs"/> <!...
SpringBoot 2.5.5整合轻量级的分布式日志标记追踪神器TLog
weixin_47367099的博客
10-19 1133
但是搭建分布式追踪系统，熟悉以及推广到全公司的系统需要一定的时间周期，而且当中涉及到链路span节点的存储成本问题，全量采集还是部分采集？2022-10-18 23:24:52.137 INFO 88321 --- [nio-8080-exec-1] com.ybchen.controller.DemoController : 多个数值-------->加了patter和joint的示例。
SpringBoot与Loki的那些事
Java_zhujia的博客
11-21 1122
Loki是Grafana Labs团队的开源项目，可以组成一个功能齐全的日志堆栈。Loki是一个水平可扩展，高可用性，多租户的日志聚合系统。它的设计非常经济高效且易于操作，因为它不会为日志内容编制索引，而是为每个日志流编制一组标签。Loki是用来存储日志和处理查询，需要通过promtail来收集日志，也可是通过后端的logback等日志框架来收集日志，通过grafana提供的loki可视化查看日志，当然了loki也提供了API，可以根据自己的需求来自己实现可视化界面，能够减少三方插件的使用。
Spring Boot+MDC 实现全链路调用日志跟踪，非常优雅！​
2301_78526383的博客
07-04 631
通过本文将了解到什么是MDC、MDC应用中存在的问题、如何解决存在的问题MDC（Mapped Diagnostic Context，映射调试上下文）是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。MDC可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。
Springboot-MDC+logback实现日志追踪
孟孟的博客
02-15 4168
一、MDC介绍 MDC（Mapped Diagnostic Contexts）映射诊断上下文，该特征是logback提供的一种方便在多线程条件下的记录日志的功能。 某些应用程序采用多线程的方式来处理多个用户的请求。在一个用户的使用过程中，可能有多个不同的线程来进行处理。典型的例子是 Web 应用服务器。当用户访问某个页面时，应用服务器可能会创建一个新的线程来处理该请求，也可能从线程池中复用已有的线程。在一个用户的会话存续期间，可能有多个线程处理过该用户的请求。这使得比较难以...
logback日志与MDC机制
热门推荐
深入一点
12-16 1万+
    logback是个比较好用的java日志输出工具包，可配置型高，而且性能优秀。   一、Layout描述 1、%logger{length}、%c{length}、%lo{length}：在日志事件的源点输出logger的名称，比如     1）LoggerFactory.getLogger(TestMain.class)，此时%logger的值为“com.xxx.TestMa...
logback的MDC机制
weixin_42581112的博客
04-07 1727
非原创，原文链接：https://www.jianshu.com/p/0436d3a4c673 logback的MDC机制 1. MDC 介绍： ​ MDC（Mapped Diagnostic Context，映射调试上下文），即将一些运行时的上下文数据通过logback打印出来，是 一种方便在多线程条件下记录日志的功能。和SiftingAppender一起，可以实现根据运行时的上下文数据，...
springboot使用logback的MDC做日志规范，便于日志系统监控
keyboard专栏
07-16 1237
首先：修改NGINX的配置文件 #在请求端生成一个全局唯一的Id，根据这个id查看整个日志的调用链，注意NGINX版本要求1.11以上 proxy_set_header X-Request-Id $request_id; #后端的Web服务器可以通过X-Forwarded-For获取用户真实IP proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add
Logback及其MDC功能详解
成长的足迹
09-26 1万+
Logback日志系统是SLF4J的原生实现。同时，Logback也是Log4j的继任者，补全了Log4j的不足。 1. Logback的模块组成 logback-core，其他模块的功能基础 logback-classic 可以看作Log4j的增强版实现。 实现了SLF4J API，能够在部署的时候提供给应用日志功能。 logback-access 集成了Servlet容器（Tomcat...
链路追踪Logback-MDC介绍
qq1164014750
01-18 1519
文章目录目标诊断上下文映射 (MDC)引入MDC 的目的MDC 的作用用法示例高级用法代码示例一些问题MDC 与线程管理代码示例MDCInsertingServletFilter注意点 目标 了解MDC基本概念和用法 参考：MDC官方文档 推荐参考 阅读前需要先了解logback的基本内容。以下内容，都是从官方文档引用，只是增加了一些示例情况。 诊断上下文映射 (MDC) 引入MDC 的目的 在一个多线程程序中，不同线程处理不同客户端的请求，如果对每个客户端都实例化一个新的且独立的 logger对象
浅谈 logback的MDC机制
大树叶 技术专栏
04-24 4462
logback的MDC机制 1. MDC 介绍： ​ MDC（Mapped Diagnostic Context，映射调试上下文），即将一些运行时的上下文数据通过logback打印出来，是 一种方便在多线程条件下记录日志的功能。和SiftingAppender一起，可以实现根据运行时的上下文数据，将日志保存到不同的文件中。 MDC（Mapped Diagnostic Context，映射调试...
SpringBoot日志配置实战：基于logback的详细指南
本文主要聚焦于使用logback来实现Spring Boot的日志配置，因为logback在性能上表现出色，并且是Spring Boot默认的日志系统。 首先，我们来看logback配置文件的构成。logback的配置文件通常命名为`logback.xml`，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值