java+springboot 做日志链路追踪

这篇具有很好参考价值的文章主要介绍了java+springboot 做日志链路追踪。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、 为什么要做日志链路追踪

  • 日志链路追踪(Log Path Tracing)是Spring Boot项目的一项关键功能,它通过将日志消息的源头与其对应的请求或响应路径相关联,实现对日志数据的可视化跟踪。
  • 随着项目规模的扩大和复杂性的增加,追踪和管理日志数据变得越来越重要。通过实现日志链路追踪,我们可以更好地理解项目中发生的各种事件,识别瓶颈并快速定位问题。这不仅可以提高开发效率,还能保证项目质量。

二、实现方法

  1. 本文使用 MDC 方案实现日志链路追踪
  2. DC(Mapped Diagnostic Context,映射调试上下文)是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。
  3. 效果展示:
    java+springboot 做日志链路追踪

三、 实现步骤

  1. 准备依赖 (可根据自己的项目修改springboot 的版本)
<dependency>
	<groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-logback-1.x</artifactId>
    <version>8.15.0</version>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.7.10</version>
	<type>pom</type>
	<scope>import</scope>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-actuator</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-actuator-autoconfigure</artifactId>
</dependency>
  1. 配置logback日志打印
    • 在项目resources目录下创建logback-spring.xml
    • 配置如下
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <contextName>${APP_NAME}</contextName>
    <springProperty name="APP_NAME" scope="context" source="spring.application.name"/>
    <springProperty name="LOG_FILE" scope="context" source="logging.file" defaultValue="../logs/application/${APP_NAME}"/>
    <springProperty name="LOG_MAXFILESIZE" scope="context" source="logback.filesize" defaultValue="50MB"/>
    <springProperty name="LOG_FILEMAXDAY" scope="context" source="logback.filemaxday" defaultValue="30"/>
    <springProperty name="ServerIP" scope="context" source="spring.cloud.client.ip-address" defaultValue="0.0.0.0"/>
    <springProperty name="ServerPort" scope="context" source="server.port" defaultValue="0000"/>
    <springProperty name="LOG_POINT_FILE" scope="context" source="logging.file" defaultValue="../logs/point"/>
    <springProperty name="LOG_AUDIT_FILE" scope="context" source="logging.file" defaultValue="../logs/audit"/>

    <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />

    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="[${APP_NAME}:${ServerIP}:${ServerPort}] %clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%level){blue} %clr(${PID}){magenta} %clr([%X{traceId}]){yellow} %clr([%thread]){orange} %clr(%logger){cyan} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}" />
    <property name="CONSOLE_LOG_PATTERN_NO_COLOR" value="[${APP_NAME}:${ServerIP}:${ServerPort}] %d{yyyy-MM-dd HH:mm:ss.SSS} %level ${PID} [%X{traceId}] [%thread] %logger %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}" />

    <!-- 控制台日志 -->
    <appender name="StdoutAppender" class="ch.qos.logback.core.ConsoleAppender">
        <withJansi>true</withJansi>
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            </layout>
        </encoder>
    </appender>
    <!-- **************************按照每天生成常规日志文件********************** -->
    <appender name="FileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_FILE}/${APP_NAME}.log</file>
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN_NO_COLOR}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--基于时间的分包策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}/${APP_NAME}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!--保留时间,单位:天-->
            <MaxHistory>${LOG_FILEMAXDAY}</MaxHistory>
            <MaxFileSize>${LOG_MAXFILESIZE}</MaxFileSize>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
        </filter>
    </appender>
    <appender name="file_async" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <appender-ref ref="FileAppender"/>
    </appender>
    <!-- **************************按照每天生成常规日志文件 end********************** -->

    <!-- *************************************** 埋点日志 start *************************************** -->
    <appender name="point_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_POINT_FILE}/point.${APP_NAME}.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}|${APP_NAME}|%msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--基于时间的分包策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <FileNamePattern>${LOG_POINT_FILE}/point.${APP_NAME}.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <!--保留时间,单位:天-->
            <MaxHistory>${LOG_FILEMAXDAY}</MaxHistory>
            <MaxFileSize>${LOG_MAXFILESIZE}</MaxFileSize>
        </rollingPolicy>
    </appender>
    <appender name="point_log_async" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <appender-ref ref="point_log"/>
    </appender>
    <!-- *************************************** 埋点日志  end  *************************************** -->

    <appender name="audit_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_AUDIT_FILE}/audit.log</file>
        <encoder>
            <pattern>%msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 基于时间的分包策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_AUDIT_FILE}/audit.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!--保留时间,单位:天-->
            <maxHistory>${LOG_FILEMAXDAY}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${LOG_MAXFILESIZE}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>

    <appender name="audit_log_async" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <appender-ref ref="audit_log"/>
    </appender>

    <!-- *************************************** logger配置 start *************************************** -->
    <logger name="cn.onehome.dubbocore.log.monitor" level="INFO" addtivity="false">
        <appender-ref ref="point_log_async" />
    </logger>
    <logger name="cn.onehome.dubbocore.log.service.impl.LoggerAuditServiceImpl" level="INFO" addtivity="false">
        <appender-ref ref="audit_log_async" />
    </logger>

    <!-- 多环境定制logger配置(根据spring.profiles.active值对应激活某个配置) -->
    <springProfile name="dev">
        <root level="INFO">
            <appender-ref ref="StdoutAppender"/>
            <appender-ref ref="file_async"/>
        </root>
    </springProfile>
    <springProfile name="test">
        <root level="INFO">
            <appender-ref ref="StdoutAppender"/>
            <appender-ref ref="file_async"/>
        </root>
    </springProfile>
    <springProfile name="pre">
        <root level="INFO">
            <appender-ref ref="StdoutAppender"/>
            <appender-ref ref="file_async"/>
        </root>
    </springProfile>
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="StdoutAppender"/>
            <appender-ref ref="file_async"/>
        </root>
    </springProfile>
    <!-- *************************************** logger配置  end  *************************************** -->
</configuration>

  1. 配置拦截器添加追踪日志参数
package cn.wje.common.filter;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.MDC;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.validation.constraints.NotNull;
import java.io.IOException;
import java.util.UUID;

/**
 * @author luoqifeng
 * @date 2023/05/18 10:13
 */
@Slf4j
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class AbstractTraceIdFilter implements Filter {

    /**
     * 放置traceId
     */
    private void putTraceId(String traceId) {
        // 放入日志请求域
        MDC.put("traceId", traceId);
    }

    /**
     * 清除traceId
     */
    private void clearTraceId() {
        try {
            MDC.remove("traceId");
        } catch (Exception e) {
            log.warn("clear traceId error. " + e.getMessage());
            // ignore
        }
    }

    /**
     * 生成traceId
     *
     * @param request
     *            请求
     * @return  traceId
     */
    @NotNull
    public static String generateTraceId(HttpServletRequest request) {
        String traceId = UUID.randomUUID().toString().replace("-", "");
        try {
            if (request != null) {
                String requestUri = request.getRequestURI();
                if (requestUri != null) {
                    if (requestUri.startsWith("/")) {
                        requestUri = requestUri.substring(1);
                    }
                    if (requestUri.endsWith("/")) {
                        requestUri = requestUri.substring(0, requestUri.length() - 1);
                    }
                    requestUri = requestUri.replace("/", ".");
                }

                // TODO 如果需要加上用户追踪,这儿可以将用户ID放入 traceId 中
                // String accountId = null;
                // TODO 获取用户ID逻辑
                // traceId = String.join("_", traceId, accountId == null ? "%s" : accountId, requestUri);
                traceId = String.join("_", traceId, requestUri);
            }
        } catch (Exception e) {
            // ignore
        }
        return traceId;
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        try {
            HttpServletRequest httpServletRequest = ((HttpServletRequest)request);
            String traceId = httpServletRequest.getHeader("traceId");
            if (StringUtils.isBlank(traceId)) {
                traceId = generateTraceId(httpServletRequest);
                log.debug("generate traceId [{}].", traceId);
            } else {
                log.debug("obtain traceId [{}] from request header. ", traceId);
            }
            // put
            putTraceId(traceId);
            chain.doFilter(httpServletRequest, response);
        } finally {
            // clear
            clearTraceId();
        }
    }
}
  1. 编写测试接口,运行测试
package cn.wjr.towerJJ.controller;

import cn.wje.common.util.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author luoqifeng
 * @date 2023/05/18 10:13
 */
@RestController
@RequestMapping("test")
@Slf4j
public class testController {

    @RequestMapping("test001")
    public Result<String> test001(){
        log.info("test001");
        return Result.success("test001");
    }
}
  1. 查看返回与结果:
    响应结果
    java+springboot 做日志链路追踪
    java+springboot 做日志链路追踪

  2. 贴上我自己封装的返回体,可以根据项目情况自行封装返回体文章来源地址https://www.toymoban.com/news/detail-450922.html

package cn.wje.common.util;

import cn.wje.common.constants.CommonErrorCode;
import org.slf4j.MDC;

import java.io.Serializable;

/**
 * @author luoqifeng
 * @date 2023/05/18 10:13
 */
public class Result<T> implements Serializable {

    private static final long serialVersionUID = -2234571636295254776L;

    /**编码**/
    private String code;
    /**失败时为失败原因**/
    private String msg;
    /**成功时的返回数据**/
    private T data;

    /**
     * traceId
     * */
    private String traceId;

    public Result() {

    }

    /**
     * 返回成功
     *
     * @param data
     * @return
     */
    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<>();
        result.setCode(CommonErrorCode.SUCCESS.getCode());
        if (data != null) {
            result.setData(data);
        }
        result.setTraceId(MDC.get("traceId"));
        return result;
    }

    /**
     * 返回成功
     *
     * @return
     */
    public static <T> Result<T> success() {
        return Result.success(null);
    }

    /**
     * 返回失败
     *
     * @return
     */
    public static <T> Result<T> fail(String code,String msg) {
        Result<T> result = new Result<>();
        result.setCode(code);
        result.setMsg(msg);
        result.setTraceId(MDC.get("traceId"));
        return result;
    }

    /**
     * 返回失败
     *
     * @return
     */
    public static <T> Result<T> fail(CommonErrorCode code) {
        return Result.fail(code.getCode(), code.getErrorMsg());
    }

    /**
     * 构建Result
     *
     * @param code
     * @param msg
     * @param data
     * @return
     */
    public static <T> Result<T> build(String code,String msg,T data) {
        Result<T> result = new Result<>();
        result.setCode(code);
        result.setMsg(msg);
        result.setData(data);
        result.setTraceId("traceId");
        return result;
    }

    /**
     * 构建Result
     *
     * @param code
     * @param data
     * @return
     */
    public static <T> Result<T> build(String code,T data) {
        return Result.build(code, null, data);
    }

    /**
     * 构建Result
     *
     * @param code
     * @param msg
     * @return
     */
    public static <T> Result<T> build(String code,String msg) {
        return Result.build(code, msg, null);
    }

    /**
     * 是否成功
     *
     * @return
     */
    public boolean isOk() {
        return CommonErrorCode.SUCCESS.getCode().equals(code);
    }

    public String getCode() {
        return code;
    }
    public void setCode(String code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public T getData() {
        return data;
    }
    public void setData(T data) {
        this.data = data;
    }

    public String getTraceId() {
        return traceId;
    }

    public void setTraceId(String traceId) {
        this.traceId = traceId;
    }
}

  1. 如果不生效,请断点调试一下拦截器(AbstractTraceIdFilter)是否成功拦截

到了这里,关于java+springboot 做日志链路追踪的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • (一)springboot实战——为什么是springboot?

    为什么是springboot?江湖夜雨,传说依旧,不懂springboot一技之长,如何混迹java圈,本节内容我们介绍一下spring的一些基本特性。尤其是springboot3的基本特性,使得我们更好的理解springboot3。 springboot的特点 -可以快速的创建一个独立的spring项目,取代老式的SSM项目 - 直接嵌入T

    2024年02月09日
    浏览(85)
  • 有了Spring为什么还需要SpringBoot呢

    目录 一、Spring缺点分析 二、什么是Spring Boot 三、Spring Boot的核心功能 3.1 起步依赖 3.2 自动装配 1. 配置文件和依赖太多了!!! spring是一个非常优秀的轻量级框架,以IOC(控制反转)和AOP(面向切面)为思想内核,极大简化了JAVA企业级项目的开发。虽然Spring的组件代码是轻

    2024年02月08日
    浏览(51)
  • springboot~InvocationHandler中为什么不能使用@Autowired

    @Autowired 是 Spring Framework 中用于自动注入依赖的注解,通常情况下可以正常工作,但有一些情况下可能无法获取到 bean 对象: Bean未定义或未扫描到 :如果要注入的 bean 没有在 Spring 上下文中定义或者没有被正确扫描到, @Autowired 将无法找到要注入的 bean。确保你的 bean 配置正

    2024年02月10日
    浏览(58)
  • 1.JavaEE进阶篇 - 为什么要学习SpringBoot呢?

    大家好,我是晓星航。今天为大家带来的是 JavaEE 进阶导读 相关的讲解!😀 学习框架相当于从“小作坊”到“工厂”的升级,小作坊什么都要自己做,工厂是组件式装配,特点就是高效。 框架更加易用、简单且高效。 框架主要体现在思维方式和编程思想上,与代码语言无关

    2024年04月15日
    浏览(48)
  • SpringBoot有的时候引入依赖为什么不用加版本号

    有的小伙伴做项目时候,引入新的包时候,会有疑问,为什么有些依赖需要加版本号,有些依赖不需要加版本号?不加版本号的依赖,版本号都写在哪里了呢? 内置的依赖可以不加版本号 这是因为SpringBoot内置了很多依赖,引入这些内置的依赖时不需要加版本号,相反,如果

    2024年01月19日
    浏览(68)
  • SpringBoot复习:(34)@EnableWebMvc注解为什么让@WebMvcAutoconfiguration失效?

    它导入了DelegatingWebMvcConfiguration 它会把容器中的类型为WebMvcConfigurer的bean注入到类型为WebMvcConfigurerComposite的成员变量configurers中。 可以看到它继承了WebMvcConfigurerSupport类 而WebMvcConfigureAutoConfiguration类定义如下 可以看到一个@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)注解。 所

    2024年02月13日
    浏览(45)
  • 深度剖析SpringBoot自动配置原理,为什么SpringBoot能为我们做那么多东西

    本文基于 spring-boot-2.2.6.RELEASE 版本的源码进行说明,不同版本的源码可能会有一些区别。 要清楚SpringBoot自动配置原理,就要明白 @SpringBootApplication 注解的组成,此注解主要是这三个注解组成: @SpringBootConfiguration , @EnableAutoConfiguration , @ComponentScan 。 下面是源码: @SpringBo

    2024年02月13日
    浏览(46)
  • SpringBoot数据源——为什么平时默认线程池是Hikari

    本文主要对DataSourceAutoConfiguration类进行讲解,然后对这个类的注解做一个解释,所以直接打开这个类,开始看…… ps:我用的版本是2.3.0.RELEASE 目录 DataSourceAutoConfiguration类注解 @Configuration(proxyBeanMethods = false) @ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class }) @ConditionalOnMis

    2024年02月06日
    浏览(56)
  • 为什么我在Linux部署的Springboot服务,部署成功之后,使用netstat -ntlp | grep java 命令查看对应服务监听的端口,只看到有tcp6的监听,没有tcp的监听?

    这种情况可能是由于 Spring Boot 默认配置使用了 IPv6 地址而没有使用 IPv4 地址。在较新的 Linux 发行版上,IPv6 通常是默认开启的。实际上,如果你的服务正在监听 IPv6 的通配地址 :: ,那么它将同时监听 IPv4(0.0.0.0)和 IPv6(::)的所有地址。换句话说,仅看到 tcp6 监听并不意味

    2024年02月06日
    浏览(49)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包