Armeria中BraveService装饰器无法在gRPC服务中传播上下文

1. 核心问题分析 #

你遇到的情况是：BraveService装饰器仅在gRPC请求的初始处理线程中绑定了TraceContext，但WebFlux的Reactor线程池（如boundedElastic、parallel）切换时，TraceContext没有自动同步到新线程的上下文，导致后续业务组件无法获取traceId/spanId。要解决这个问题，需要打通Brave与Reactor的上下文传播机制。

2. 具体解决步骤 #

步骤1：添加Brave-Reactor适配依赖 #

确保项目引入Brave对Reactor的支持包：

<dependency>
    <groupId>io.zipkin.brave</groupId>
    <artifactId>brave-reactor</artifactId>
    <version>${brave.version}</version> <!-- 保持与现有Brave版本一致 -->
</dependency>

步骤2：修改Tracing配置，支持Reactor上下文传播 #

更新Tracing Bean的配置，加入Reactor上下文装饰器，让TraceContext能在Reactor线程间传递：

@Bean
public Tracing tracing() {
    return Tracing.newBuilder()
            .serviceName("grpc-demo-service")
            .currentTraceContext(
                    CurrentTraceContext.newBuilder()
                            // 保留MDC装饰器，让日志能读取traceId/spanId
                            .addScopeDecorator(MDCScopeDecorator.get())
                            // 添加Reactor上下文装饰器，支持Reactor线程间的TraceContext传播
                            .addScopeDecorator(ReactorContextScopeDecorator.get())
                            .build()
            )
            .sampler(Sampler.ALWAYS_SAMPLE) // 根据需求配置采样策略
            .build();
}

步骤3：注册Reactor上下文传播钩子 #

通过Spring事件在应用启动时注册Reactor操作符钩子，确保TraceContext自动注入Reactor上下文：

@Bean
public ApplicationListener<ContextRefreshedEvent> reactorTraceContextHook(Tracing tracing) {
    return event -> {
        // 注册钩子，让TraceContext在Mono/Flux线程切换时自动传播
        Hooks.onEachOperator(TracerContextOperator.create(tracing.tracer()));
    };
}

步骤4：同步Armeria请求上下文到Reactor #

在gRPC服务实现中，将Armeria的RequestContext写入Reactor上下文，避免上下文丢失：

@Autowired
private Tracer tracer;
@Autowired
private JustService justService;

@Override
public void testRpc(TestRequest request, StreamObserver<TestResponse> responseObserver) {
    // 获取当前Armeria请求上下文
    RequestContext armeriaCtx = RequestContext.current();
    
    Mono.just(request)
            // 将Armeria上下文写入Reactor Context
            .contextWrite(ArmeriaReactor.context(armeriaCtx))
            // 执行异步业务逻辑
            .flatMap(req -> justService.processRequest(req))
            .subscribe(
                    result -> {
                        responseObserver.onNext(TestResponse.newBuilder().setResult(result).build());
                        responseObserver.onCompleted();
                    },
                    error -> responseObserver.onStatus(Status.INTERNAL.withCause(error))
            );
}

步骤5：在业务组件中获取TraceContext #

在JustService或JustRepository中，通过Brave的Tracer直接获取当前TraceContext：

@Service
public class JustService {
    private static final Logger log = LoggerFactory.getLogger(JustService.class);
    private final Tracer tracer;

    public JustService(Tracer tracer) {
        this.tracer = tracer;
    }

    public Mono<String> processRequest(TestRequest request) {
        return Mono.deferContextual(contextView -> {
            // 通过Tracer获取当前TraceContext
            TraceContext traceContext = tracer.currentTraceContext().get();
            String traceId = traceContext.traceIdString();
            
            log.info("traceId: {}", traceId);
            return Mono.just("processed-" + request.getName());
        }).subscribeOn(Schedulers.boundedElastic());
    }
}

步骤6：验证日志配置 #

确保日志配置（如logback）正确读取MDC中的traceId和spanId字段：

<encoder>
    <pattern>%d{ISO8601} %-5level [%X{traceId},%X{spanId}] %logger{36} - %msg%n</pattern>
</encoder>

关键原理说明 #

• ReactorContextScopeDecorator：将Brave的TraceContext绑定到Reactor的Context中，线程切换时Reactor会自动携带该上下文。
• TracerContextOperator：Reactor操作符钩子，确保线程切换时TraceContext从当前Scope同步到Reactor Context，再从Context同步到新线程的Scope。
• ArmeriaReactor.context()：将Armeria的RequestContext写入Reactor Context，确保业务组件能访问请求相关上下文。

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