当 WebClient Rest 调用时，侦探不会在日志中显示 Trace Id / Span Id

Question

在使用 Webclient 调用 rest api 时，很少会打印如下默认日志，但侦探不会添加 traacid。 见下文：

2022-08-10 10:18:26.123 DEBUG [cib_bulk,,] 1 --- [or-http-epoll-1] r.netty.http.client.HttpClientConnect    : [7c54bef8-1, L:/1.1.1.:60568 - R:xyz.c11.1.1.:443] Handler is being applied: {uri=xyz.c/services/productInventory/v2/product/search/count?abc=2346&status=ACTIVE, method=GET}

此处仅附有应用程序名称 [cib_bulk,,]。 但是在整个应用程序中，当我通过 logger 手动登录时，然后侦探附加 traceid 和 span id。

@Bean
public WebClient webClientWithTimeout() {
    String baseUrl = environment.getProperty("cibase.productapi.service.url");  
    LOG.info("Base Url of Product Inventory Service: {}",baseUrl);
    
    String username = environment.getProperty("cibase.productapi.basicauth.username");
    String password = environment.getProperty("cibase.productapi.basicauth.password");
    String trackingid = environment.getProperty("cibase.productapi.basicauth.trackingid");
    String trackingIdValue = environment.getProperty("cibase.productapi.basicauth.trackingid.value");
    
    HttpClient httpClient = HttpClient.create();

    Builder builder =  
             WebClient.builder()
            .codecs(configurer -> configurer.defaultCodecs().maxInMemorySize(IN_MEMORY_SIZE))
            .filter(basicAuthentication(username, password));
    
    if(trackingid != null){
        builder.defaultHeader(trackingid, trackingIdValue);
    }
    return builder.baseUrl(baseUrl).clientConnector(new ReactorClientHttpConnector(httpClient)).build();
}

==============

 List<Product> productList = webClient
                  .get()
                  .uri(uriBuilder -> uriBuilder.path(MessageConstants.PRODUCT_INVENTORY_API_URL).replaceQuery(queryString).build())
                  .retrieve()
                  .bodyToFlux(Product.class)
                  .collectList()
                  .retryWhen(retryConfiguration())
                  .block();

=====

<dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-sleuth</artifactId>
          <version>3.1.1</version>
        </dependency>

Answer 1

我找到了解决方案。 只需使用以下代码在日志记录中打印 Trace id 和 spanId。 此代码对于以漂亮格式打印 REST 调用的请求和响应正文也很有用。

     import static org.springframework.web.reactive.function.client.ExchangeFilterFunctions.basicAuthentication;
        import org.slf4j.Logger;
        import org.slf4j.LoggerFactory;
        import org.springframework.beans.factory.annotation.Autowired;
        import org.springframework.context.annotation.Bean;
        import org.springframework.context.annotation.Configuration;
        import org.springframework.core.env.Environment;
        import org.springframework.http.client.reactive.ReactorClientHttpConnector;
        import org.springframework.web.reactive.function.client.WebClient;
        import org.springframework.web.reactive.function.client.WebClient.Builder;
        
        import brave.http.HttpTracing;
        import io.netty.handler.logging.LogLevel;
        import reactor.netty.http.brave.ReactorNettyHttpTracing;
        import reactor.netty.http.client.HttpClient;
        import reactor.netty.transport.logging.AdvancedByteBufFormat;
    
    
     @Configuration
     public class WebClientConfiguration {
        public static final Logger LOG = LoggerFactory.getLogger(WebClientConfiguration.class);
    
    @Autowired
    private Environment environment;

    private static final int IN_MEMORY_SIZE = -1; // unlimited in-memory 

/* Step 1: This bean is responsible to add Sleuth generated TraceId and SpanId in logs*/
    @Bean
    ReactorNettyHttpTracing reactorNettyHttpTracing(final HttpTracing httpTracing) {
        return ReactorNettyHttpTracing.create(httpTracing);
    }
     
    @Bean
    public WebClient webClientWithTimeout(final ReactorNettyHttpTracing reactorNettyHttpTracing) {
        String baseUrl = environment.getProperty("cibase.productapi.service.url");  
        LOG.info("Base Url of Product Inventory Service: {}",baseUrl);
        
        String username = environment.getProperty("cibase.productapi.basicauth.username");
        String password = environment.getProperty("cibase.productapi.basicauth.password");
        String trackingid = environment.getProperty("cibase.productapi.basicauth.trackingid");
        String trackingIdValue = environment.getProperty("cibase.productapi.basicauth.trackingid.value");
        
// wiretap used to log request and response body
        HttpClient httpClient = HttpClient.create().wiretap(this.getClass().getCanonicalName(), LogLevel.DEBUG, AdvancedByteBufFormat.TEXTUAL);
    
        Builder builder =  
                 WebClient.builder()
                .codecs(configurer -> configurer.defaultCodecs().maxInMemorySize(IN_MEMORY_SIZE))
                .filter(basicAuthentication(username, password));
                
        if(trackingid != null){
            builder.defaultHeader(trackingid, trackingIdValue);
        }
   /* step 2. reactorNettyHttpTracing object used here */
        return builder
                .baseUrl(baseUrl)
                .clientConnector(new ReactorClientHttpConnector(reactorNettyHttpTracing.decorateHttpClient(httpClient)))
                .build();   // here we have used the above bean
    }
    
}