基于Spring Boot + Dubbo的全链路日志追踪(二)
时间:2022-07-22
本文章向大家介绍基于Spring Boot + Dubbo的全链路日志追踪(二),主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。
一、概要
紧接上一篇,完成分析之后,就要具体的实现了。
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
。
请求完成之后,将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 定时任务等触发(内部)
(略...)
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://192.168.0.150:20001
provider:
filter: dubboTraceIdFilter
consumer:
filter: dubboTraceIdFilter
三、结果
3.1 HTTP请求结果返回
3.2 日志服务查询
- 通过Mono 在 Heroku 上运行 .NET 应用
- 百度地图聚合
- LVS DR模式 RealServer 为 Windows 2008 R2配置
- android画图之贝塞尔曲线讲解
- 地图开发添加标注物
- lambda表达式-编译测试
- MongoDB 聚合管道(Aggregation Pipeline)
- 高仿今日头条
- Web打印组件jatoolsPrinter
- Android-Universal-Image-Loader图片异步加载并缓存
- RESTful API 设计最佳实践
- Hello Bonjour!
- SQL Server 2008 FILESTREAM特性管理文件
- 验证码类库CaptchaMvc
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释
- 3种 Springboot 全局时间格式化方式,别再写重复代码了
- 一文搞懂CDN加速原理
- 3分钟短文:Laravel Carbon自定义日期时间格式
- (30)字符截取命令sed
- 2. Bean Validation声明式校验方法的参数、返回值
- 如何识别和阻止基于电报的僵尸网络
- 由String,String Builder,String Buffer 引起的面试惨案
- MySQL案例:各类临时文件的存放位置
- 关于加@Transactional注解的方法之间调用,事务是否生效的问题
- 基于Vue实现一个有点意思的拼拼乐小游戏
- 硬核手写字节码实现HelloWorld
- 由 go orm 引发的探索
- 为什么不建议在 for 循环里捕捉异常?
- 我就是想找个下标,怎么用到二分查找了?
- 利用Decorator和SourceMap优化JavaScript错误堆栈