基于Spring Boot + Dubbo的全鏈路日志追蹤是怎樣的

基于Spring Boot + Dubbo的全鏈路日志追蹤是怎樣的，針對(duì)這個(gè)問(wèn)題，這篇文章詳細(xì)介紹了相對(duì)應(yīng)的分析和解答，希望可以幫助更多想解決這個(gè)問(wèn)題的小伙伴找到更簡(jiǎn)單易行的方法。

一、概要

完成分析之后，就要具體的實(shí)現(xiàn)了。

service-a: 實(shí)現(xiàn)dubbo服務(wù)。

service-b: 實(shí)現(xiàn)web服務(wù)，并調(diào)用service-a實(shí)現(xiàn)的服務(wù)。

二、實(shí)現(xiàn)

2.1 日志采集及存儲(chǔ)

本例直接使用【阿里云·日志服務(wù)】進(jìn)行數(shù)據(jù)存儲(chǔ)和檢索，使用Aliyun Log Logback Appender進(jìn)行日志收集及上傳。

其實(shí)就是阿里自己實(shí)現(xiàn)了一個(gè)Logback Appender。當(dāng)然我們也可以自己實(shí)現(xiàn)，比如上傳至自建的ELK中。

2.2 項(xiàng)目中traceId生成、傳遞、銷毀

2.2.1 traceId生成、銷毀

2.2.1.1 客戶端請(qǐng)求等觸發(fā)(外部)

外部類請(qǐng)求觸發(fā)情況，使用攔截器處理。

請(qǐng)求過(guò)來(lái)之后，生成traceId，并寫入org.slf4j.MDC。

請(qǐng)求完成之后，將traceId從org.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 定時(shí)任務(wù)等觸發(fā)(內(nèi)部)

(略...)

2.2.1 traceId傳遞

2.2.1.1 WEB類傳遞

簡(jiǎn)單的接口返回類，增加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);
    }
}

當(dāng)請(qǐng)求響應(yīng)結(jié)果生成前，獲取當(dāng)前org.slf4j.MDC中的traceId，設(shè)置到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;
    }
}

最終，接口響應(yīng)數(shù)據(jù)例如如下：

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

2.2.1.2 Dubbo類傳遞

traceId的存儲(chǔ)使用org.apache.dubbo.rpc.RpcContext(內(nèi)部使用InternalThreadLocal實(shí)現(xiàn))。

借助Dubbo的過(guò)濾器來(lái)實(shí)現(xiàn)，traceId在Dubbo服務(wù)間的讀取、寫入和清除。

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/文件夾下，創(chuàng)建com.alibaba.dubbo.rpc.Filter文本文件。內(nèi)容為dubboTraceIdFilter=com.example.dubboservicea.filter.DubboTraceIdFilter。

而后，spring-boot配置文件中 配置dubbo的過(guò)濾器

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

三、結(jié)果

3.1 HTTP請(qǐng)求結(jié)果返回

3.2 日志服務(wù)查詢

關(guān)于基于Spring Boot + Dubbo的全鏈路日志追蹤是怎樣的問(wèn)題的解答就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關(guān)注億速云行業(yè)資訊頻道了解更多相關(guān)知識(shí)。