TracingFilter
Sleuth是通过Brave的TracingFilter达到收集Span信息的目的。
我们可以自定义Filter来对Span信息做一些自定义的修改,比如增加tag或者响应头信息。注意:自定义的Filter的优先级要比TracingFilter的低,不然无法拿到TracingFilter处理之后的信息。
Baggage
Baggage是存储在Span上下文的一组Key/Value的键值对,跟traceId和spanId不同,它不是必选项。
它相当于Sleuth暴露的一个功能接口,通过它,我们可以让自定义数据沿着调用链一直往后传递。典型的应用场景是登陆信息的传递。
实例
客户端
自定义过滤器
package com.springcloud.sleuthconsumer.filter;
import brave.propagation.ExtraFieldPropagation;
import org.springframework.cloud.sleuth.instrument.web.SleuthWebProperties;
import org.springframework.cloud.sleuth.instrument.web.TraceWebServletAutoConfiguration;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.GenericFilterBean;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.regex.Pattern;
/**
* 自定义过滤器,
* 获取当前的SessionId, 放入Baggage中
* 注意, 因为不是所有的请求都需要往后传递, 所以会对一些请求跳过执行
*/
@Component
@Order(TraceWebServletAutoConfiguration.TRACING_FILTER_ORDER + 1)
public class SessionFilter extends GenericFilterBean {
private Pattern skipPattern = Pattern.compile(SleuthWebProperties.DEFAULT_SKIP_PATTERN);
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
if (!(request instanceof HttpServletRequest) || !(response instanceof HttpServletResponse)) {
throw new ServletException("Filter just supports HTTP requests");
}
HttpServletRequest httpRequest = (HttpServletRequest) request;
boolean skip = skipPattern.matcher(httpRequest.getRequestURI()).matches();
if (!skip) {
// 将 SessionId 放到 Baggage 中
ExtraFieldPropagation.set("SessionId", httpRequest.getSession().getId());
}
filterChain.doFilter(request, response);
}
}
配置文件中配置
spring:
application:
name: sleuth-consumer
sleuth:
baggage-keys: # 注意, Sleuth2.0.0之后, baggage的 key 必须在这里配置才能生效
- SessionId
服务端配置文件中配置
spring:
application:
name: sleuth-consumer
sleuth:
baggage-keys: # 注意, Sleuth2.0.0之后, baggage的 key 必须在这里配置才能生效
- SessionId
调用ExtraFieldPropagation.get("SessionId");
获取