如何通过 Spring Cloud Sleuth 与 Brave 扩展实现在微服务全链路追踪中注入自定义的业务标识

秋涛姑娘_5924

秋涛姑娘_5924

2026-04-24

856人浏览

原创

spring cloud sleuth 必须通过 brave 的 tracecontext 机制(如 baggage)跨线程/跨服务透传 userid 等字段,mdc 因仅限当前线程而不可靠;baggage 支持自动 http 头传播(baggage-user-id)和 zipkin 按值查询。

如何通过 spring cloud sleuth 与 brave 扩展实现在微服务全链路追踪中注入自定义的业务标识

Spring Cloud Sleuth 默认只注入 traceId 和 spanId,业务系统常需额外透传如 userId、tenantId、requestSource 等上下文字段——这些不能靠日志 MDC 手动塞,否则跨线程、跨服务会丢失。必须走 Brave 的 TraceContext 传播机制,否则 Zipkin UI 里查不到、下游服务也拿不到。

为什么不能只用 MDC.put("userId", "123")?

MDC 是线程局部变量,仅在当前线程有效。一旦遇到异步(CompletableFuture、@Async)、线程池(ThreadPoolTaskExecutor)、消息中间件(Kafka、RabbitMQ)或 Feign 调用,MDC 内容就断了。Sleuth 的 TraceContext 则通过 Brave 的 CurrentTraceContext + Scope 机制自动跨线程/跨服务传递,这才是可靠路径。

如何用 Brave 的 Customizer 注入自定义字段?

关键不是改日志格式,而是把业务标识写进 Span 的 tags 或 Baggage。推荐优先用 Baggage:它支持自动 HTTP 头透传(baggage-xxx),且 Zipkin 支持按 baggage 查询,比 tags 更语义清晰。

  • 在启动类或配置类中声明 BaggageField:
    @Bean
    public BaggageField userIdBaggageField() {
        return BaggageField.create("user-id");
    }
  • 注册 CurrentTraceContextCustomizer,让 Baggage 随 TraceContext 自动传播:
    @Bean
    public CurrentTraceContextCustomizer currentTraceContextCustomizer(
            BaggageField userIdBaggageField) {
        return builder -> builder.addScopeDecorator(
                BaggagePropagationScopeDecorator.create(userIdBaggageField));
    }
  • 在请求入口(如 Filter 或 WebMvcConfigurer)中设置值:
    userIdBaggageField.updateValue(Tracing.current().tracer().currentSpan(), "U987654321");

Feign / RestTemplate 调用时如何确保 Baggage 透传?

Sleuth 默认已集成 Brave 的 HttpClientParser 和 OkHttpParser,但前提是你的 Feign 客户端用了 spring-cloud-starter-openfeign(而非裸用 OpenFeign),且未覆盖默认的 Feign.Builder。常见踩坑点:

  • 手动 new Feign.builder() 会绕过 Sleuth 自动装饰,必须用 FeignAutoConfiguration 提供的 bean;
  • RestTemplate 需启用拦截器:RestTemplate restTemplate = new RestTemplate(new TraceRestTemplateInterceptor(tracer, spanNamer));,但更推荐直接用 Sleuth 自动装配的 RestTemplate bean(加 @LoadBalanced 即可);
  • HTTP header 名默认是 baggage-user-id,下游服务需同样配置 BaggageField.create("user-id") 才能读取,否则值为空。

自定义字段在 Zipkin 和日志中怎么查?

Baggage 字段不会自动出现在 Zipkin UI 的 Span 标签栏,需显式调用 Span.tag("user-id", value) 才可见;但查询时仍可用 user-id:U987654321 过滤整条 Trace。日志中若用 Logback + %X{user-id},需配合 Slf4jScopeDecorator 启用 MDC 自动同步(Sleuth 3.1+ 默认开启,老版本需手动配)。

最易忽略的是:Baggage 值变更后,必须调用 updateValue(),而不是 getValue() —— 后者只读,且返回的是上一个 Scope 的值,不是当前 Span 的。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3249

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2328

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1260

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2198

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3540

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16215

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.8万人学习