Issue with the sleuth Baggage for setting local fields using property "spring.sleuth.baggage.local-fields"

[bharatvarshney2022]

Describe the bug
Issue with the sleuth Baggage for setting local fields using property "spring.sleuth.baggage.local-fields", "spring.sleuth.bagdgage.correlation-fields", understanding is that if we set this property with specified property then local fields(which are not supposed to travel over wire) will be setup and injected in the MDC map.
Which is not happening currently!!

Whereas if "spring.sleuth.baggage.remote-fields" and "spring.sleuth.bagdgage.correlation-fields" properties are set then its working as expected, values are transferred to MDC automatically and injected in the headers which can be transferred over wire automatically.
Which is working as expected.

Sample

E.g

Version

Pom.xml

<spring-boot.version>2.3.7.RELEASE</spring-boot.version>
<sleuth.version>2.2.6.RELEASE</sleuth.version>

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-zipkin</artifactId>
  <version>${sleuth.version}</version>
</dependency>

---

application.properties
spring.sleuth.bagdgage.correlation-fields=user_name
spring.sleuth.baggage.local-fields=user_name

Controller classes if we access like MDC.get("user_name")
Not able to get the value over here!!!

---

Value of the "user_name" is passed as the header value in the REST API call.
user_name:testing_header

[marcingrzejszczak]

Can you provide a complete, minimal, verifiable sample that reproduces the problem rather than pasted code? It should be available as a GitHub (or similar) project or attached to this issue as a zip file.

Also please update to the latest version of cloud and boot and please tell us if the problem persists.

[bharatvarshney2022]

Thanks @marcingrzejszczak for the suggestions. Checked with the latest version, still not worked.
Will upload the sample code base shortly.

[tarunlalwani]

@bharatvarshney2022 , please update the latest sample code

[spring-cloud-issues]

If you would like us to look at this issue, please provide the requested information. If the information is not provided within the next 7 days this issue will be closed.

[spring-cloud-issues]

Closing due to lack of requested feedback. If you would like us to look at this issue, please provide the requested information and we will re-open the issue.

[norbertwnuk]

I would like ask to re-open this defect, observe exactly the same behavior for MDC and BaggageField.getAllValues(), when the header is not added to remote-fields. At least for BaggageField.getAllValues() is seems to be related to MAP_STRING_STRING_BUILDER logic. This behavior is inconsistent with what documentation says about BaggageField and MDC when combined with local fields.

spring:
  sleuth:
    baggage:
      remote-fields:
        - x-request-id
      local-fields:
        - x-request-id-2
      correlation-fields:
        - x-request-id
        - x-request-id-2
      tag-fields:
        - x-request-id
        - x-request-id-2

[marcingrzejszczak]

Have you configured the BaggageFields to flush on update? Maybe that's why you don't see it yet. Do you have a sample that I could play around with?

[norbertwnuk]

@marcingrzejszczak - from what i see flush on update does not change the behavior, the sample code is here.

[norbertwnuk]

@marcingrzejszczak - can we re-open this issue / should I create a new one - since the failing example has been attached above.

[grassehh]

Hello, it seems this issue is still present with Spring Boot 3 / Micrometer. I have created an issue to Brave because after some analysis it seems to be an implementatiion behavior (Seems to have something to do with the way the correlation fields are stored in TraceContext.extraList property).

[marcingrzejszczak]

The issue seems to be there in Brave