文档章节

基于Spring Boot + Dubbo的全链路日志追踪(二)

明天以后
 明天以后
发布于 08/10 12:03
字数 821
阅读 1382
收藏 25

一、概要

紧接上一篇,完成分析之后,就要具体的实现了。

service-a: 实现dubbo服务。

service-b: 实现web服务,并调用service-a实现的服务。

二、实现

2.1 日志采集及存储

本例直接使用【阿里云·日志服务】进行数据存储和检索,使用Aliyun Log Logback Appender进行日志收集及上传。

其实就是阿里自己实现了一个Logback Appender。当然我们也可以自己实现,比如上传至自建的ELK中。

2.2 项目中traceId生成、传递、销毁

2.2.1 traceId生成、销毁

2.2.1.1 客户端请求等触发(外部)

外部类请求触发情况,使用拦截器处理。

请求过来之后,生成traceId,并写入org.slf4j.MDC

请求完成之后,将traceIdorg.slf4j.MDC中移除。

package com.example.dubboserviceb.interceptor;

import com.example.dubboserviceb.constants.Constants;
import org.slf4j.MDC;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

/**
 * @author lpe234
 * @since 2019/5/25 14:43
 */
public class TraceIdInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        // generate traceId
        String traceId = UUID.randomUUID().toString().replace("-", "");

        // put traceId
        MDC.put(Constants.TRACE_ID, traceId);

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

        // clear traceId
        MDC.remove(Constants.TRACE_ID);
    }
}

2.2.1.2 定时任务等触发(内部)

(略...)

2.2.1 traceId传递

2.2.1.1 WEB类传递

简单的接口返回类,增加traceId字段。

package com.example.dubboserviceb.utils;

import lombok.Data;

/**
 * @author lpe234
 * @since 2019/5/25 14:55
 */
@Data
public class RestResponse<T> {
    private Integer code;
    private String msg;
    private T data;
    private String traceId;

    public RestResponse() {
    }

    public RestResponse(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public static <T> RestResponse<T> ok(T data) {
        return new RestResponse<>(200, "ok", data);
    }

    public static <T> RestResponse<T> error(T data) {
        return new RestResponse<>(400, "error", data);
    }
}

当请求响应结果生成前,获取当前org.slf4j.MDC中的traceId,设置到RestResponse中。

package com.example.dubboserviceb.advice;

import com.example.dubboserviceb.constants.Constants;
import com.example.dubboserviceb.utils.RestResponse;
import org.slf4j.MDC;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

/**
 * @author lpe234
 * @since 2019/5/25 15:03
 */
@ControllerAdvice
public class ResponseModifyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {

        // put traceId to response
        ((RestResponse) o).setTraceId(MDC.get(Constants.TRACE_ID));

        return o;
    }
}

最终,接口响应数据例如如下:

{
  "code": 200,
  "msg": "ok",
  "data": "Hello apple",
  "traceId": "6c25de3422374d51be58555ae9c380e8"
}

2.2.1.2 Dubbo类传递

traceId的存储使用org.apache.dubbo.rpc.RpcContext(内部使用InternalThreadLocal实现)。

借助Dubbo的过滤器来实现,traceId在Dubbo服务间的读取、写入和清除。

package com.example.dubboservicea.filter;

import com.example.dubboservicea.constants.Constants;
import org.apache.dubbo.common.extension.Activate;
import org.apache.dubbo.rpc.*;
import org.slf4j.MDC;

/**
 * @author lpe234
 * @since 2019/5/25 15:24
 */
@Activate(group = {org.apache.dubbo.common.Constants.PROVIDER, org.apache.dubbo.common.Constants.CONSUMER})
public class DubboTraceIdFilter implements Filter {

    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {

        RpcContext rpcContext = RpcContext.getContext();

        // before
        if (rpcContext.isProviderSide()) {
            // get traceId from dubbo consumer,and set traceId to MDC
            String traceId = rpcContext.getAttachment(Constants.TRACE_ID);
            MDC.put(Constants.TRACE_ID, traceId);
        }

        if (rpcContext.isConsumerSide()) {
            // get traceId from MDC, and set traceId to rpcContext
            String traceId = MDC.get(Constants.TRACE_ID);
            rpcContext.setAttachment(Constants.TRACE_ID, traceId);
        }

        Result result = invoker.invoke(invocation);

        // after
        if (rpcContext.isProviderSide()) {
            // clear traceId from MDC
            MDC.remove(Constants.TRACE_ID);
        }

        return result;
    }

    @Override
    public Result onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
        return result;
    }
}

另,需要在resources/META-INF/dubbo/文件夹下,创建com.alibaba.dubbo.rpc.Filter文本文件。内容为dubboTraceIdFilter=com.example.dubboservicea.filter.DubboTraceIdFilter

而后,spring-boot配置文件中 配置dubbo的过滤器

#dubbo
dubbo:
  scan:
    base-packages: com.example.dubboservicea.provider, com.example.dubboservicea.reference
  protocol:
    name: dubbo
    port: 12101
  registry:
    address: zookeeper://118.190.204.150:20084
  provider:
    filter: dubboTraceIdFilter
  consumer:
    filter: dubboTraceIdFilter

三、结果

3.1 HTTP请求结果返回

3.2 日志服务查询

© 著作权归作者所有

明天以后

明天以后

粉丝 74
博文 130
码字总数 87367
作品 0
昌平
程序员
私信 提问
加载中

评论(7)

老谭12345
dubbo 向rpcContext内塞traceId的动作呢?
明天以后
明天以后 博主
老哥看的太仔细了😅
老谭12345
我前不久也这么搞的,用眼跑了下你代码。。。
老谭12345
你还缺logback配置文件吧,起码本机日志里打一下mdc里的参数 。另外我loghubAppender里也加自定义pattern了,把mdc参数输出了 比如 %date [%level] [%thread] [%X{projectId}] [%X{USERID}] [%X{IP}] [%X{REQUESTID}] %logger{60} [%file : %line] %msg%n
唐代de豆腐
唐代de豆腐
是的
微服务资源springboot、springcloud、docker、dubbo项目实战等倾心分享

精彩内容 java实战练习项目教程 全网最全电子图书分享 你所需要的大数据视频教程 java学习视频教程及源码 今天又是周末,还是想给大家送一些福利,因为最近一直有小伙伴问我要springboot等微...

公众号_好好学java
2018/08/06
187
0
探秘Dubbo原理与源码及实操

阅读源码的作用 提取设计思路,增强设计能力 理解运行机制,便于快速解决问题以及功能扩展 常见有关dubbo的问题 dubbo的负载均衡是在哪个组件中处理的? dubbo默认的负载均衡算法是什么? 如...

liwei2000
2018/12/12
255
0
SpringBoot整合Dubbo案例

使用框架: jdk 1.8 springboot-2.1.3 dubbo-2.6 spring-data-jpa-2.1.5 一、开发dubbo服务接口: 按照Dubbo官方开发建议,创建一个接口项目,该项目只定义接口和model类; 1、创建springboo...

ggod
06/09
140
0
springboot dubbox 实例

---------------------------------------------------------------------------------------------------------------- springboot 详解 (一) helloworld 下载demo springboot 详解 (二)......

curiousby
2017/01/19
0
0
微服务选择Spring Cloud还是Dubbo?

点击关注 异步图书,置顶公众号 每天与你分享 IT好书 技术干货 职场知识 参与文末话题讨论,每日赠送异步图书。 ——异步小编 在阿里巴巴的生态中,微服务逐渐成为主要的服务形态,伴随着容器...

异步社区
2018/04/27
0
0

没有更多内容

加载失败,请刷新页面

加载更多

OSChina 周日乱弹 —— 我,小小编辑,食人族酋长

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @宇辰OSC :分享娃娃的单曲《飘洋过海来看你》: #今日歌曲推荐# 《飘洋过海来看你》- 娃娃 手机党少年们想听歌,请使劲儿戳(这里) @宇辰OSC...

小小编辑
今天
466
10
MongoDB系列-- SpringBoot 中对 MongoDB 的 基本操作

SpringBoot 中对 MongoDB 的 基本操作 Database 库的创建 首先 在MongoDB 操作客户端 Robo 3T 中 创建数据库: 增加用户User: 创建 Collections 集合(类似mysql 中的 表): 后面我们大部分都...

TcWong
今天
19
0
spring cloud

一、从面试题入手 1.1、什么事微服务 1.2、微服务之间如何独立通讯的 1.3、springCloud和Dubbo有哪些区别 1.通信机制:DUbbo基于RPC远程过程调用;微服务cloud基于http restFUL API 1.4、spr...

榴莲黑芝麻糊
今天
9
0
Executor线程池原理与源码解读

线程池为线程生命周期的开销和资源不足问题提供了解决方 案。通过对多个任务重用线程,线程创建的开销被分摊到了多个任务上。 线程实现方式 Thread、Runnable、Callable //实现Runnable接口的...

小强的进阶之路
昨天
30
0
maven 环境隔离

解决问题 即 在 resource 文件夹下面 ,新增对应的资源配置文件夹,对应 开发,测试,生产的不同的配置内容 <resources> <resource> <directory>src/main/resources.${deplo......

之渊
昨天
29
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部