Skip to content
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

header values are be expected to be W3C baggage encoded #6164

Merged
merged 6 commits into from
Feb 1, 2024
Merged

header values are be expected to be W3C baggage encoded #6164

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0afa8ef
header values are be expected to be W3C baggage encoded
zeitlinger Jan 18, 2024
66c9b6a
Update exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otl…
zeitlinger Jan 19, 2024
01779f3
Update exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otl…
zeitlinger Jan 19, 2024
ef98252
header values are be expected to be W3C baggage encoded
zeitlinger Jan 19, 2024
56ef081
Add test to confirm non-encoded headers still work
jack-berg Jan 23, 2024
5c4b4dd
spotless
jack-berg Jan 25, 2024
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
14 changes: 13 additions & 1 deletion exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpConfigUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import java.io.RandomAccessFile;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Locale;
import java.util.Map;
Expand Down Expand Up @@ -89,7 +91,17 @@ public static void configureOtlpExporterBuilder(
if (headers.isEmpty()) {
headers = config.getMap("otel.exporter.otlp.headers");
}
headers.forEach(addHeader);
for (Map.Entry<String, String> entry : headers.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
try {
// headers are encoded as URL - see
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specifying-headers-via-environment-variables
addHeader.accept(key, URLDecoder.decode(value, StandardCharsets.UTF_8.displayName()));
} catch (Exception e) {
throw new ConfigurationException("Cannot decode header value: " + value, e);
}
}

String compression = config.getString("otel.exporter.otlp." + dataType + ".compression");
if (compression == null) {
Expand Down
17 changes: 15 additions & 2 deletions ...l/src/test/java/io/opentelemetry/exporter/otlp/internal/OtlpSpanExporterProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down Expand Up @@ -219,7 +220,7 @@ void createExporter_HttpWithGeneralConfiguration() throws CertificateEncodingExc
config.put("otel.exporter.otlp.certificate", certificatePath);
config.put("otel.exporter.otlp.client.key", clientKeyPath);
config.put("otel.exporter.otlp.client.certificate", clientCertificatePath);
config.put("otel.exporter.otlp.headers", "header-key=header-value");
config.put("otel.exporter.otlp.headers", "header-key=header%20value");
config.put("otel.exporter.otlp.compression", "gzip");
config.put("otel.exporter.otlp.timeout", "15s");
config.put("otel.experimental.exporter.otlp.retry.enabled", "true");
Expand All @@ -229,7 +230,7 @@ void createExporter_HttpWithGeneralConfiguration() throws CertificateEncodingExc
assertThat(exporter).isInstanceOf(OtlpHttpSpanExporter.class);
verify(httpBuilder, times(1)).build();
verify(httpBuilder).setEndpoint("https://localhost:443/v1/traces");
verify(httpBuilder).addHeader("header-key", "header-value");
verify(httpBuilder).addHeader("header-key", "header value");
verify(httpBuilder).setCompression("gzip");
verify(httpBuilder).setTimeout(Duration.ofSeconds(15));
verify(httpBuilder).setTrustedCertificates(serverTls.certificate().getEncoded());
Expand Down Expand Up @@ -274,4 +275,16 @@ void createExporter_HttpWithSignalConfiguration() throws CertificateEncodingExce
}
Mockito.verifyNoInteractions(grpcBuilder);
}

@Test
void createExporter_decodingError() {
Assertions.assertThatThrownBy(
() -> {
provider.createExporter(
DefaultConfigProperties.createFromMap(
Collections.singletonMap("otel.exporter.otlp.headers", "header-key=%-1")));
})
.isInstanceOf(ConfigurationException.class)
.hasMessage("Cannot decode header value: %-1");
}
}
Loading