Test http client captured headers (#7993)

laurit · web-flow · commit a51535d08ee0 · 2023-03-07T20:05:29.000+02:00
diff --git a/instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/test/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTest.java b/instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/test/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTest.java
@@ -8,6 +8,7 @@
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientInstrumentationExtension;
+import java.util.Collections;
 import org.apache.http.client.config.RequestConfig;
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.impl.client.HttpClientBuilder;
@@ -26,7 +27,13 @@ protected InstrumentationExtension testing() {
   @Override
   protected CloseableHttpClient createClient(boolean readTimeout) {
     HttpClientBuilder builder =
-        ApacheHttpClientTelemetry.create(testing.getOpenTelemetry()).newHttpClientBuilder();
+        ApacheHttpClientTelemetry.builder(testing.getOpenTelemetry())
+            .setCapturedRequestHeaders(
+                Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+            .setCapturedResponseHeaders(
+                Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
+            .build()
+            .newHttpClientBuilder();
     RequestConfig.Builder requestConfigBuilder =
         RequestConfig.custom()
             .setMaxRedirects(2)
diff --git a/instrumentation/armeria-1.3/library/src/test/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaHttpClientTest.java b/instrumentation/armeria-1.3/library/src/test/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaHttpClientTest.java
@@ -7,8 +7,10 @@
 
 import com.linecorp.armeria.client.WebClientBuilder;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientInstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientTestOptions;
+import java.util.Collections;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 class ArmeriaHttpClientTest extends AbstractArmeriaHttpClientTest {
@@ -19,7 +21,13 @@ class ArmeriaHttpClientTest extends AbstractArmeriaHttpClientTest {
   @Override
   protected WebClientBuilder configureClient(WebClientBuilder clientBuilder) {
     return clientBuilder.decorator(
-        ArmeriaTelemetry.create(testing.getOpenTelemetry()).newClientDecorator());
+        ArmeriaTelemetry.builder(testing.getOpenTelemetry())
+            .setCapturedClientRequestHeaders(
+                Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+            .setCapturedClientResponseHeaders(
+                Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
+            .build()
+            .newClientDecorator());
   }
 
   @Override
diff --git a/instrumentation/jaxrs-client/jaxrs-client-2.0-testing/src/test/groovy/ResteasyProxyClientTest.groovy b/instrumentation/jaxrs-client/jaxrs-client-2.0-testing/src/test/groovy/ResteasyProxyClientTest.groovy
@@ -74,6 +74,11 @@ class ResteasyProxyClientTest extends HttpClientTest<ResteasyProxyResource> impl
   boolean testCallback() {
     false
   }
+
+  @Override
+  boolean testCapturedHttpHeaders() {
+    false
+  }
 }
 
 @Path("")
diff --git a/instrumentation/jetty-httpclient/jetty-httpclient-9.2/library/src/test/groovy/io/opentelemetry/instrumentation/jetty/httpclient/v9_2/JettyHttpClient9LibraryTest.groovy b/instrumentation/jetty-httpclient/jetty-httpclient-9.2/library/src/test/groovy/io/opentelemetry/instrumentation/jetty/httpclient/v9_2/JettyHttpClient9LibraryTest.groovy
@@ -7,14 +7,18 @@ package io.opentelemetry.instrumentation.jetty.httpclient.v9_2
 
 
 import io.opentelemetry.instrumentation.test.LibraryTestTrait
+import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest
 import org.eclipse.jetty.client.HttpClient
 import org.eclipse.jetty.util.ssl.SslContextFactory
 
 class JettyHttpClient9LibraryTest extends AbstractJettyClient9Test implements LibraryTestTrait {
 
   @Override
   HttpClient createStandardClient() {
-    return JettyClientTelemetry.create(getOpenTelemetry()).getHttpClient()
+    return JettyClientTelemetry.builder(getOpenTelemetry())
+      .setCapturedRequestHeaders([AbstractHttpClientTest.TEST_REQUEST_HEADER])
+      .setCapturedResponseHeaders([AbstractHttpClientTest.TEST_RESPONSE_HEADER])
+      .build().getHttpClient()
   }
 
   @Override
diff --git a/instrumentation/ktor/ktor-2.0/library/src/test/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/KtorHttpClientTest.kt b/instrumentation/ktor/ktor-2.0/library/src/test/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/KtorHttpClientTest.kt
@@ -80,6 +80,8 @@ class KtorHttpClientTest : AbstractHttpClientTest<HttpRequestBuilder>() {
     private fun HttpClientConfig<*>.installTracing() {
       install(KtorClientTracing) {
         setOpenTelemetry(TESTING.openTelemetry)
+        setCapturedRequestHeaders(listOf(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+        setCapturedResponseHeaders(listOf(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
       }
     }
   }
diff --git a/instrumentation/netty/netty-4.1/library/src/test/java/io/opentelemetry/instrumentation/netty/v4_1/Netty41ClientTest.java b/instrumentation/netty/netty-4.1/library/src/test/java/io/opentelemetry/instrumentation/netty/v4_1/Netty41ClientTest.java
@@ -8,7 +8,9 @@
 import io.netty.channel.Channel;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientInstrumentationExtension;
+import java.util.Collections;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 public class Netty41ClientTest extends AbstractNetty41ClientTest {
@@ -22,6 +24,10 @@ public class Netty41ClientTest extends AbstractNetty41ClientTest {
           channelPipeline ->
               channelPipeline.addLast(
                   NettyClientTelemetry.builder(testing.getOpenTelemetry())
+                      .setCapturedRequestHeaders(
+                          Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+                      .setCapturedResponseHeaders(
+                          Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
                       .build()
                       .createCombinedHandler()));
 
diff --git a/instrumentation/okhttp/okhttp-3.0/library/src/test/java/io/opentelemetry/instrumentation/okhttp/v3_0/OkHttp3Test.java b/instrumentation/okhttp/okhttp-3.0/library/src/test/java/io/opentelemetry/instrumentation/okhttp/v3_0/OkHttp3Test.java
@@ -6,7 +6,9 @@
 package io.opentelemetry.instrumentation.okhttp.v3_0;
 
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientInstrumentationExtension;
+import java.util.Collections;
 import okhttp3.Call;
 import okhttp3.OkHttpClient;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -18,6 +20,12 @@ public class OkHttp3Test extends AbstractOkHttp3Test {
 
   @Override
   public Call.Factory createCallFactory(OkHttpClient.Builder clientBuilder) {
-    return OkHttpTelemetry.create(testing.getOpenTelemetry()).newCallFactory(clientBuilder.build());
+    return OkHttpTelemetry.builder(testing.getOpenTelemetry())
+        .setCapturedRequestHeaders(
+            Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+        .setCapturedResponseHeaders(
+            Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
+        .build()
+        .newCallFactory(clientBuilder.build());
   }
 }
diff --git a/instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackTelemetry.java b/instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackTelemetry.java
@@ -18,8 +18,10 @@
 import ratpack.registry.RegistrySpec;
 
 /**
- * Entrypoint for instrumenting Ratpack servers. To apply OpenTelemetry to a server, configure the
- * {@link RegistrySpec} using {@link #configureServerRegistry(RegistrySpec)}.
+ * Entrypoint for instrumenting Ratpack server and http client.
+ *
+ * <p>To apply OpenTelemetry instrumentation to a server, configure the {@link RegistrySpec} using
+ * {@link #configureServerRegistry(RegistrySpec)}.
  *
  * <pre>{@code
  * RatpackTelemetry telemetry = RatpackTelemetry.create(OpenTelemetrySdk.builder()
@@ -30,6 +32,16 @@
  *   server.handlers(chain -> ...);
  * });
  * }</pre>
+ *
+ * <p>To apply OpenTelemetry instrumentation to a http client, wrap the {@link HttpClient} using
+ * {@link #instrumentHttpClient(HttpClient)}.
+ *
+ * <pre>{@code
+ * RatpackTelemetry telemetry = RatpackTelemetry.create(OpenTelemetrySdk.builder()
+ *   ...
+ *   .build());
+ * HttpClient instrumentedHttpClient = telemetry.instrumentHttpClient(httpClient);
+ * }</pre>
  */
 public final class RatpackTelemetry {
 
diff --git a/instrumentation/ratpack/ratpack-1.7/library/src/test/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackHttpClientTest.java b/instrumentation/ratpack/ratpack-1.7/library/src/test/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackHttpClientTest.java
@@ -6,7 +6,9 @@
 package io.opentelemetry.instrumentation.ratpack.v1_7;
 
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientInstrumentationExtension;
+import java.util.Collections;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import ratpack.func.Action;
 import ratpack.http.client.HttpClient;
@@ -19,7 +21,12 @@ class RatpackHttpClientTest extends AbstractRatpackHttpClientTest {
 
   @Override
   protected HttpClient buildHttpClient() throws Exception {
-    return RatpackTelemetry.create(testing.getOpenTelemetry())
+    return RatpackTelemetry.builder(testing.getOpenTelemetry())
+        .setCapturedClientRequestHeaders(
+            Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+        .setCapturedClientResponseHeaders(
+            Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
+        .build()
         .instrumentHttpClient(HttpClient.of(Action.noop()));
   }
 
diff --git a/instrumentation/spring/spring-web/spring-web-3.1/library/src/test/java/io/opentelemetry/instrumentation/spring/web/v3_1/SpringWebInstrumentationTest.java b/instrumentation/spring/spring-web/spring-web-3.1/library/src/test/java/io/opentelemetry/instrumentation/spring/web/v3_1/SpringWebInstrumentationTest.java
@@ -15,6 +15,7 @@
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientTestOptions;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 import java.net.URI;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
@@ -41,7 +42,14 @@ static void setUp() {
     restTemplate = new RestTemplate(requestFactory);
     restTemplate
         .getInterceptors()
-        .add(SpringWebTelemetry.create(testing.getOpenTelemetry()).newInterceptor());
+        .add(
+            SpringWebTelemetry.builder(testing.getOpenTelemetry())
+                .setCapturedRequestHeaders(
+                    Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+                .setCapturedResponseHeaders(
+                    Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
+                .build()
+                .newInterceptor());
   }
 
   @Override
diff --git a/instrumentation/spring/spring-webflux-5.0/library/src/test/java/io/opentelemetry/instrumentation/spring/webflux/v5_0/client/SpringWebfluxClientInstrumentationTest.java b/instrumentation/spring/spring-webflux-5.0/library/src/test/java/io/opentelemetry/instrumentation/spring/webflux/v5_0/client/SpringWebfluxClientInstrumentationTest.java
@@ -7,7 +7,9 @@
 
 import io.opentelemetry.instrumentation.spring.webflux.client.AbstractSpringWebfluxClientInstrumentationTest;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientInstrumentationExtension;
+import java.util.Collections;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.springframework.web.reactive.function.client.WebClient;
 
@@ -20,7 +22,12 @@ class SpringWebfluxClientInstrumentationTest
   @Override
   protected WebClient.Builder instrument(WebClient.Builder builder) {
     SpringWebfluxTelemetry instrumentation =
-        SpringWebfluxTelemetry.create(testing.getOpenTelemetry());
+        SpringWebfluxTelemetry.builder(testing.getOpenTelemetry())
+            .setCapturedRequestHeaders(
+                Collections.singletonList(AbstractHttpClientTest.TEST_REQUEST_HEADER))
+            .setCapturedResponseHeaders(
+                Collections.singletonList(AbstractHttpClientTest.TEST_RESPONSE_HEADER))
+            .build();
     return builder.filters(instrumentation::addClientTracingFilter);
   }
 }
diff --git a/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/base/HttpClientTest.groovy b/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/base/HttpClientTest.groovy
@@ -356,6 +356,12 @@ abstract class HttpClientTest<REQUEST> extends InstrumentationSpecification {
     junitTest.requestWithExistingTracingHeaders()
   }
 
+  def "test captured HTTP headers"() {
+    assumeTrue(testCapturedHttpHeaders())
+    expect:
+    junitTest.captureHttpHeaders()
+  }
+
   def "connection error (unopened port)"() {
     assumeTrue(testConnectionFailure())
     expect:
@@ -471,6 +477,10 @@ abstract class HttpClientTest<REQUEST> extends InstrumentationSpecification {
     true
   }
 
+  boolean testCapturedHttpHeaders() {
+    true
+  }
+
   boolean testConnectionFailure() {
     true
   }
diff --git a/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/http/AbstractHttpClientTest.java b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/http/AbstractHttpClientTest.java
@@ -51,6 +51,8 @@
 public abstract class AbstractHttpClientTest<REQUEST> implements HttpClientTypeAdapter<REQUEST> {
   public static final Duration CONNECTION_TIMEOUT = Duration.ofSeconds(5);
   public static final Duration READ_TIMEOUT = Duration.ofSeconds(2);
+  public static final String TEST_REQUEST_HEADER = "X-Test-Request";
+  public static final String TEST_RESPONSE_HEADER = "X-Test-Response";
 
   static final String BASIC_AUTH_KEY = "custom-authorization-header";
   static final String BASIC_AUTH_VAL = "plain text auth token";
@@ -443,6 +445,34 @@ void requestWithExistingTracingHeaders() throws Exception {
         });
   }
 
+  @Test
+  void captureHttpHeaders() throws Exception {
+    URI uri = resolveAddress("/success");
+    String method = "GET";
+    int responseCode =
+        doRequest(method, uri, Collections.singletonMap(TEST_REQUEST_HEADER, "test"));
+
+    assertThat(responseCode).isEqualTo(200);
+
+    testing.waitAndAssertTraces(
+        trace -> {
+          trace.hasSpansSatisfyingExactly(
+              span -> {
+                assertClientSpan(span, uri, method, responseCode).hasNoParent();
+                span.hasAttributesSatisfying(
+                    attrs -> {
+                      assertThat(attrs)
+                          .containsEntry(
+                              "http.request.header.x_test_request", new String[] {"test"});
+                      assertThat(attrs)
+                          .containsEntry(
+                              "http.response.header.x_test_response", new String[] {"test"});
+                    });
+              },
+              span -> assertServerSpan(span).hasParent(trace.getSpan(0)));
+        });
+  }
+
   @Test
   void connectionErrorUnopenedPort() {
     assumeTrue(options.getTestConnectionFailure());
diff --git a/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/http/HttpClientTestServer.java b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/http/HttpClientTestServer.java
@@ -6,6 +6,8 @@
 package io.opentelemetry.instrumentation.testing.junit.http;
 
 import static io.opentelemetry.api.trace.SpanKind.SERVER;
+import static io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest.TEST_REQUEST_HEADER;
+import static io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest.TEST_RESPONSE_HEADER;
 import static io.opentelemetry.testing.internal.armeria.common.MediaType.PLAIN_TEXT_UTF_8;
 
 import io.opentelemetry.api.OpenTelemetry;
@@ -62,6 +64,10 @@ protected void configure(ServerBuilder sb) throws Exception {
               if (testRequestId != null) {
                 headers.set("test-request-id", testRequestId);
               }
+              String capturedHeader = req.headers().get(TEST_REQUEST_HEADER);
+              if (capturedHeader != null) {
+                headers.set(TEST_RESPONSE_HEADER, capturedHeader);
+              }
               return HttpResponse.of(headers.build(), HttpData.ofAscii("Hello."));
             })
         .service(

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,11 @@ class ResteasyProxyClientTest extends HttpClientTest<ResteasyProxyResource> impl`
`74`	`74`	`boolean testCallback() {`
`75`	`75`	`false`
`76`	`76`	`}`
	`77`	`+`
	`78`	`+ @Override`
	`79`	`+ boolean testCapturedHttpHeaders() {`
	`80`	`+ false`
	`81`	`+ }`
`77`	`82`	`}`
`78`	`83`
`79`	`84`	`@Path("")`
Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,8 @@ class KtorHttpClientTest : AbstractHttpClientTest<HttpRequestBuilder>() {`
`80`	`80`	`private fun HttpClientConfig<*>.installTracing() {`
`81`	`81`	`install(KtorClientTracing) {`
`82`	`82`	`setOpenTelemetry(TESTING.openTelemetry)`
	`83`	`+ setCapturedRequestHeaders(listOf(AbstractHttpClientTest.TEST_REQUEST_HEADER))`
	`84`	`+ setCapturedResponseHeaders(listOf(AbstractHttpClientTest.TEST_RESPONSE_HEADER))`
`83`	`85`	`}`
`84`	`86`	`}`
`85`	`87`	`}`