侦查行李在联调局不起作用

Question

请提示我如何让侦察行李在联调系统中工作。它在测试通过模拟HTTP请求时按预期工作，但在测试直接调用服务时不工作。我的应用程序是（Spring Boot 2.5.4，Spring Cloud 2020.0.3）：

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

    @Bean
    BaggageField myBaggageField() {
        return BaggageField.create("my-field-name");
    }

    @RestController
    static class MyController {

        @AutowiredMyService myService;

        @GetMapping
        String callService() {
            return myService.updateAndGet();
        }
    }

    @Service
    static class MyService {

        @Autowired BaggageField baggageField;

        public String updateAndGet() {
            baggageField.updateValue("value");
            return baggageField.getValue();
        }
    }
}

应用yml:spring。侦探。行李远程字段：我的字段名

测试：

@SpringBootTest
@AutoConfigureMockMvc
class MyApplicationTests {

    @Autowired
    MyService myService;

    @Autowired
    MockMvc mockMvc;

    @Test
    void testBaggageByService() {
        assertThat(myService.updateAndGet()).isEqualTo("value");         // FAILS
    }

    @Test
    void testBaggageByController() throws Exception {
        mockMvc.perform(get("/")).andExpect(content().string("value"));  // PASS
    }
}

Answer 1

如果出于任何原因，启动一个span应该在许多测试中重用，那就是我的JUnit 5扩展：

public class SleuthExtension implements BeforeEachCallback, AfterEachCallback {

    private static final Namespace SPAN_STORE_KEY = Namespace.create(SleuthExtension.class.getName());
    private static final String SPAN_KEY = "test span";

    @Override
    public void beforeEach(ExtensionContext context) {
        Tracer tracer = SpringExtension.getApplicationContext(context)
            .getBean(Tracer.class);
        ScopedSpan span = tracer.startScopedSpan("span for " + context.getDisplayName());

        context.getStore(SPAN_STORE_KEY)
            .put(SPAN_KEY, span);
    }

    @Override
    public void afterEach(ExtensionContext context) {
        context.getStore(SPAN_STORE_KEY)
            .remove(SPAN_KEY, ScopedSpan.class)
            .end();
    }

}

Answer 2

这是意料之中的，因为您只是调用控制器的方法。Sleuth仪表基本上是一个Servlet过滤器，在第一次测试中没有调用，但在第二次测试中使用，因为它模拟接收真实的请求（而且，它也不是真正的联调）。

您可以手动创建跨度，并设置行李以模拟您跳过的行为。

Answer 3

请阅读文档关于冲洗和更新选项在勇敢-https://docs.spring.io/spring-cloud-sleuth/docs/current/reference/html/project-features.html#features-baggage

设置此选项，然后重试

// configuration
@Bean
BaggageField countryCodeField() {
    return BaggageField.create("my-field-name");
}

@Bean
ScopeDecorator mdcScopeDecorator() {
    return MDCScopeDecorator.newBuilder()
            .clear()
            .add(SingleCorrelationField.newBuilder(countryCodeField())
                    .flushOnUpdate()
                    .build())
            .build();
}

编辑：

在你的评论中，你说：

好吧，Sleuth instrumentation是一个Servlet过滤器，但是另外还有很多其他的instrumentation，例如message listener、quartz scheduler等。我只是想也应该有用于集成测试的instrumentation

没有这样的集成，我看不出有任何意义。你必须自己启动一个跨度，在测试中手动启动，并将其放入范围内。你可以在这里找到一个例子https://github.com/spring-cloud/spring-cloud-sleuth/blob/v3.0.3/tests/common/src/main/java/org/springframework/cloud/sleuth/instrument/circuitbreaker/CircuitBreakerIntegrationTests.java#L55-L71

@Autowired
Tracer tracer;

@Autowired
CircuitBreakerFactory factory;

@Test
public void should_pass_tracing_information_when_using_circuit_breaker() {
    // given
    Tracer tracer = this.tracer;
    ScopedSpan scopedSpan = null;
    try {
        scopedSpan = tracer.startScopedSpan("start");
        // when
        Span span = this.factory.create("name").run(tracer::currentSpan);

        BDDAssertions.then(span).isNotNull();
        BDDAssertions.then(scopedSpan.context().traceId()).isEqualTo(span.context().traceId());
    }
    finally {
        scopedSpan.end();
    }
}