Best way to pass custom headers along with Sleuth X-B3* headers

Question

As per the README here , I am using the following configuration to pass x-vcap-request-id and x-vcap-group-id from one application to the other.

@Bean
public Factory propagationFactory() {
    return brave.propagation.ExtraFieldPropagation.newFactory(brave.propagation.B3Propagation.FACTORY,
            "x-vcap-request-id", "x-vcap-group-id");
}

@Bean
public TracingFactoryBean tracing() {
    TracingFactoryBean tracingFactoryBean = new TracingFactoryBean();
    tracingFactoryBean.setPropagationFactory(propagationFactory());
    return tracingFactoryBean;
}

However, this configuration is messing up default sleuth behavior. With this code, Sleuth no longer adds TraceId and SpanId to the log

What's the best/recommended way to pass along custom headers between microservices ?

score 4 · Accepted Answer · edited Oct 19 '18 at 16:11

If you read the docs on prefixed fields you'll see the following section

A difference from previous versions of Sleuth is that, with Brave, you must pass the list of baggage keys. There are two properties to achieve this. With the spring.sleuth.baggage-keys, you set keys that get prefixed with baggage- for HTTP calls and baggage_ for messaging. You can also use the spring.sleuth.propagation-keys property to pass a list of prefixed keys that are whitelisted without any prefix.

Just set the properties and things will work out of the box. It's always good to read the project documentation.

score 1 · Answer 2 · edited Jun 25 '18 at 20:44

1

I haven't used TracingFactoryBean, but adding Slf4jCurrentTraceContext in TracingBuilder solved it for me.

return Tracing.newBuilder().propagationFactory(ExtraFieldPropagation.newFactory(B3Propagation.FACTORY, "request-id"))
        .currentTraceContext(Slf4jCurrentTraceContext.create())
        .build();

edited Jun 25 '18 at 20:44

pushkin

9,575
15
51
95

answered Jun 25 '18 at 20:38

Gajendra Singh Rao

11
1

Slf4jCurrentTraceContext is marked as deprecated in spring-cloud-sleuth-core 2.2.8.RELEASE. – Krzysztof Tomaszewski Sep 01 '22 at 14:37

score 0 · Answer 3 · answered Oct 07 '22 at 10:50

With latest Spring Cloud Sleuth you need just to set properties:

spring.sleuth.baggage.remote-fields=my-header,other-header
spring.sleuth.baggage.correlation-fields=my-header,other-header

Maybe even only one of them needed. Anyway it will not harm to set both properies to the same value: a list of HTTP header names to be propagated. This, when using RestTemplate, WebClient or Feign client, will cause adding listed headers to the outgoing HTTP request when the incoming HTTP request has these headers. Please note that HTTP client must be a Spring bean so Spring Cloud Sleuth can instrument it.

Best way to pass custom headers along with Sleuth X-B3* headers

3 Answers3