Spring Cloud Sleuth Servlet和WebFlux获取当前span并添加tag

﹏ヽ暗。殇╰゛Y 2022-10-22 12:56 171阅读 0赞

### 文章目录 ###

*  Spring Cloud Sleuth Servlet和WebFlux获取当前span并添加tag
 *   *  Servlet自定义Span Tag
     *  WebFlux自定义Span Tag

# Spring Cloud Sleuth Servlet和WebFlux获取当前span并添加tag #

## Servlet自定义Span Tag ##

对于普通基于spring mvc的web应用，只需要在任何位置依赖`brave.Tracer`，就可以拿到当前span，并可给span添加tag：

public class MyFilter extends OncePerRequestFilter { 
    	@Autowired
        private Tracer tracer;
    
    	@Override
        protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws ServletException, IOException { 
    		Span span = tracer.currentSpan();
    		chain.doFilter(request, response);
    		span.tag("myTag", "myTagValue");
    	}
    }

上面的例子是在Filter中获取当前链路的span，并添加一个Tag，其原理是利用ThreadLocal，把当前请求线程中的Span保存起来，只要是在同一个线程中的操作，都可以获取到当前Span。

## WebFlux自定义Span Tag ##

如果我们直接把servlet获取Span的方法移植过来，会发现始终都是Null，因为Servlet是同步阻塞IO，一个请求会在一个线程中完成，因此可以使用ThreadLocal来保存Span，但是WebFlux基于异步IO，每个线程并不是只为一个请求工作，因此就不能使用ThreadLocal来保存Span。

WebFlux中有一个`Context`类，功能可以媲美`ThreadLocal`，这个Context保存同一个请求的上下文，但是它并不能像ThreadLocal那样直接获取，只能通过WebFlux订阅：

public class MyFilter implements WebFilter { 
    
        @Autowired
        private Environment env;
    
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) { 
            return chain.filter(exchange).subscriberContext(context -> { 
                try { 
                    Span span = context.get(Span.class);
                    if (span != null) { 
                        span.tag("name", env.getProperty("spring.application.name"));
                    }
                } catch (Exception e) { 
                    log.error("span error", e);
                }
                return context;
            });
        }

Span放入Context的代码可以在`TraceWebFilter`中找到：

...
    			WebFilterTraceSubscriber(CoreSubscriber<? super Void> actual, Context context,
    					Span span, MonoWebFilterTrace parent) { 
    				this.actual = actual;
    				this.span = span;
    				this.context = context.put(Span.class, span);
    				this.exchange = parent.exchange;
    				this.handler = parent.handler;
    			}
    ...

不过随着spring-cloud-sleuth的更新，这里的实现逻辑发生了变化，新的版本中不再向context中存放Span：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70]  
如果必须从context中获取当前Span，可以通过策略来屏蔽版本差异。

但是除了在contex中存放了span以外，TraceWebFilter还在Exchange中保存了：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 1]  
因此还可以用下面的方式获取：

public class MyFilter implements WebFilter { 
    
        @Autowired
        private Environment env;
    
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) { 
            return chain.filter(exchange).subscriberContext(context -> { 
                try { 
                    Span span = (Span) exchange.getAttributes().get(TraceWebFilter.class.getName() + ".TRACE");
                    if (span != null) { 
                        span.tag("name", env.getProperty("spring.application.name"));
                    }
                } catch (Exception e) { 
                    log.error("span error", e);
                }
                return context;
            });
        }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70]: /images/20221022/3bcabf76d14a4297b7db0726c4f519d9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NMX1lE_size_16_color_FFFFFF_t_70 1]: /images/20221022/5955f1bd1a16416a90f8a19d7a5b2447.png