Skip to content

Fix Jaeger propagator baggage header case sensitivity #8496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
thswlsqls wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −4
Draft

Fix Jaeger propagator baggage header case sensitivity #8496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

## Unreleased

### API

#### Extensions

* Trace propagators: Match Jaeger baggage header keys case insensitively

## Version 1.63.0 (2026-06-05)

### API
Expand Down
10 changes: 6 additions & 4 deletions ...pagators/src/main/java/io/opentelemetry/extension/trace/propagation/JaegerPropagator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import java.nio.charset.StandardCharsets;
import java.util.Collection;
import java.util.Collections;
import java.util.Locale;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -255,13 +256,14 @@ private static <C> Baggage getBaggageFromHeader(@Nullable C carrier, TextMapGett
if (entriesAdded >= MAX_BAGGAGE_ENTRIES || bytesAdded > MAX_BAGGAGE_BYTES) {
break;
}
if (key.startsWith(BAGGAGE_PREFIX)) {
if (key.length() == BAGGAGE_PREFIX.length()) {
String lowercaseKey = key.toLowerCase(Locale.ROOT);
if (lowercaseKey.startsWith(BAGGAGE_PREFIX)) {
if (lowercaseKey.length() == BAGGAGE_PREFIX.length()) {
continue;
}
String value = getter.get(carrier, key);
if (value != null) {
String baggageKey = key.substring(BAGGAGE_PREFIX.length());
String baggageKey = lowercaseKey.substring(BAGGAGE_PREFIX.length());
if (bytesAdded + baggageKey.length() + value.length() > MAX_BAGGAGE_BYTES) {
break;
}
Expand All @@ -272,7 +274,7 @@ private static <C> Baggage getBaggageFromHeader(@Nullable C carrier, TextMapGett
entriesAdded++;
bytesAdded += baggageKey.length() + value.length();
}
} else if (key.equals(BAGGAGE_HEADER)) {
} else if (lowercaseKey.equals(BAGGAGE_HEADER)) {
String value = getter.get(carrier, key);
if (value != null) {
if (builder == null) {
Expand Down
17 changes: 17 additions & 0 deletions ...tors/src/test/java/io/opentelemetry/extension/trace/propagation/JaegerPropagatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,23 @@ void extract_baggageOnly_withHeader_andPrefix() {
.build());
}

@Test
void extract_baggageOnly_capitalizedHeaders() {
Map<String, String> carrier = new LinkedHashMap<>();
// Some TextMapGetters return header keys in their original case (e.g. undertow 1.7), so baggage
// matching must be case insensitive.
carrier.put("Uberctx-some-key", "value");
carrier.put("Jaeger-Baggage", "nometa=nometa-value,meta=meta-value");

assertThat(fromContext(jaegerPropagator.extract(Context.current(), carrier, getter)))
.isEqualTo(
Baggage.builder()
.put("some-key", "value")
.put("nometa", "nometa-value")
.put("meta", "meta-value")
.build());
}

@Test
void extract_nullContext() {
assertThat(jaegerPropagator.extract(null, Collections.emptyMap(), getter))
Expand Down
Loading