Spring Cloud Stream SB3与SB2追踪头兼容性问题及方案咨询

核心问题定位 #

Spring Boot 3（搭配Micrometer，对应Spring Cloud 2023.0.x版本）通过Spring Cloud Stream Kafka发消息时，会把B3、traceparent头里的追踪ID做Base64编码；而Spring Boot 2（搭配Sleuth，对应Spring Cloud 2021.0.x版本）用的是明文格式追踪ID，两者格式不匹配导致无法传递追踪上下文。

实现SB3不编码追踪ID的解决方案 #

1. 配置Micrometer追踪属性（推荐） #

直接在application.yml或application.properties里添加配置，指定用明文编码器替代默认的Base64编码器：

management:
  tracing:
    propagation:
      trace-id-encoder: plain

2. 自定义追踪ID转换器 #

如果上述配置不生效，可以通过实现TraceIdConverter接口强制输出明文追踪ID：

import io.micrometer.tracing.TraceIdConverter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class TracingConfig {
    @Bean
    public TraceIdConverter traceIdConverter() {
        return new TraceIdConverter() {
            @Override
            public String convert(String traceId) {
                // 直接返回原始traceId，不做Base64编码
                return traceId;
            }

            @Override
            public String reverse(String convertedTraceId) {
                // 反向转换时直接返回传入值，适配SB2的明文ID
                return convertedTraceId;
            }
        };
    }
}

3. 手动处理Spring Cloud Stream Kafka消息头 #

如果前两种方案都无法解决，可自定义ChannelInterceptor手动写入明文格式的追踪头：

import org.springframework.cloud.stream.config.ChannelInterceptorFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.support.ChannelInterceptor;
import org.springframework.messaging.support.MessageBuilder;

@Configuration
public class StreamTracingInterceptorConfig {
    @Bean
    public ChannelInterceptorFactory tracingChannelInterceptorFactory() {
        return channelName -> new ChannelInterceptor() {
            @Override
            public Message<?> preSend(Message<?> message, MessageChannel channel) {
                io.micrometer.tracing.Tracer tracer = 
                    org.springframework.context.ApplicationContextHolder.getApplicationContext()
                        .getBean(io.micrometer.tracing.Tracer.class);
                io.micrometer.tracing.Span currentSpan = tracer.currentSpan();
                if (currentSpan != null) {
                    // 手动添加明文格式的B3和traceparent头
                    return MessageBuilder.fromMessage(message)
                        .setHeader("b3", currentSpan.context().traceId() + "-" + currentSpan.context().spanId() + "-1")
                        .setHeader("traceparent", "00-" + currentSpan.context().traceId() + "-" + currentSpan.context().spanId() + "-01")
                        .build();
                }
                return message;
            }
        };
    }
}

验证步骤 #

1. 在SB3服务发送Kafka消息，查看消息头的b3和traceparent字段，确认追踪ID为明文；
2. 用SB2服务消费该消息，检查是否能正确解析追踪上下文并延续链路；
3. 反向验证SB2发消息、SB3消费的链路是否正常。

内容的提问来源于stack exchange，提问作者hiimjames