Test http client stable semconv (#9178)

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpCommonAttributesExtractor.java

@@ -14,6 +14,7 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.internal.SemconvStability;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 import java.util.HashSet;
@@ -50,7 +51,7 @@ abstract class HttpCommonAttributesExtractor<
  public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
  String method = getter.getHttpRequestMethod(request);
  if (SemconvStability.emitStableHttpSemconv()) {
- if (knownMethods.contains(method)) {
+ if (method == null || knownMethods.contains(method)) {
  internalSet(attributes, HttpAttributes.HTTP_REQUEST_METHOD, method);
  } else {
  internalSet(attributes, HttpAttributes.HTTP_REQUEST_METHOD, _OTHER);

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpMessageBodySizeUtil.java

@@ -7,6 +7,7 @@
 
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.internal.SemconvStability;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
 import javax.annotation.Nullable;

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsView.java

@@ -8,6 +8,7 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;

instrumentation-api-semconv/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/http/internal/HttpAttributes.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.api.instrumenter.http.internal;
+
+import static io.opentelemetry.api.common.AttributeKey.longKey;
+import static io.opentelemetry.api.common.AttributeKey.stringKey;
+
+import io.opentelemetry.api.common.AttributeKey;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public final class HttpAttributes {
+
+ // FIXME: remove this class and replace its usages with SemanticAttributes once schema 1.21 is
+ // released
+
+ public static final AttributeKey<String> HTTP_REQUEST_METHOD = stringKey("http.request.method");
+
+ public static final AttributeKey<String> HTTP_REQUEST_METHOD_ORIGINAL =
+ stringKey("http.request.method_original");
+
+ public static final AttributeKey<Long> HTTP_REQUEST_BODY_SIZE = longKey("http.request.body.size");
+
+ public static final AttributeKey<Long> HTTP_RESPONSE_BODY_SIZE =
+ longKey("http.response.body.size");
+
+ public static final AttributeKey<Long> HTTP_RESPONSE_STATUS_CODE =
+ longKey("http.response.status_code");
+
+ private HttpAttributes() {}
+}

instrumentation-api-semconv/src/test/java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsViewTest.java

@@ -13,6 +13,7 @@
 import static org.assertj.core.api.Assertions.entry;
 
 import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;

instrumentation-api-semconv/src/testBothHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractorBothSemconvTest.java

@@ -16,6 +16,7 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;

instrumentation-api-semconv/src/testBothHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractorBothSemconvTest.java

@@ -16,6 +16,7 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;

instrumentation-api-semconv/src/testStableHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientAttributesExtractorStableSemconvTest.java

@@ -18,6 +18,7 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.instrumentation.api.internal.HttpConstants;

instrumentation-api-semconv/src/testStableHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientExperimentalMetricsStableSemconvTest.java

@@ -15,6 +15,7 @@
 import io.opentelemetry.api.trace.TraceState;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.OperationListener;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;

instrumentation-api-semconv/src/testStableHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientMetricsStableSemconvTest.java

@@ -15,6 +15,7 @@
 import io.opentelemetry.api.trace.TraceState;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.OperationListener;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;

instrumentation-api-semconv/src/testStableHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerAttributesExtractorStableSemconvTest.java

@@ -18,6 +18,7 @@
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.instrumentation.api.internal.HttpConstants;

instrumentation-api-semconv/src/testStableHttpSemconv/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpServerMetricsStableSemconvTest.java

@@ -15,6 +15,7 @@
 import io.opentelemetry.api.trace.TraceState;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.OperationListener;
+import io.opentelemetry.instrumentation.api.instrumenter.http.internal.HttpAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.network.internal.NetworkAttributes;
 import io.opentelemetry.instrumentation.api.instrumenter.url.internal.UrlAttributes;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;

instrumentation/akka/akka-http-10.0/javaagent/build.gradle.kts

@@ -42,14 +42,29 @@ dependencies {
  latestDepTestLibrary("com.typesafe.akka:akka-stream_2.13:+")
 }
 
-tasks.withType<Test>().configureEach {
- // required on jdk17
- jvmArgs("--add-exports=java.base/sun.security.util=ALL-UNNAMED")
- jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ filter {
+ includeTestsMatching("AkkaHttpClientInstrumentationTest")
+ }
+ include("**/AkkaHttpClientInstrumentationTest.*")
+
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ withType<Test>().configureEach {
+ // required on jdk17
+ jvmArgs("--add-exports=java.base/sun.security.util=ALL-UNNAMED")
+ jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
 
- jvmArgs("-Dio.opentelemetry.javaagent.shaded.io.opentelemetry.context.enableStrictContext=false")
+  jvmArgs("-Dio.opentelemetry.javaagent.shaded.io.opentelemetry.context.enableStrictContext=false")
 
- systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+ systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
 }
 
 if (findProperty("testLatestDeps") as Boolean) {

instrumentation/apache-httpasyncclient-4.1/javaagent/build.gradle.kts

@@ -16,3 +16,13 @@ muzzle {
 dependencies {
  library("org.apache.httpcomponents:httpasyncclient:4.1")
 }
+
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
+}

instrumentation/apache-httpclient/apache-httpclient-2.0/javaagent/build.gradle.kts

@@ -17,7 +17,15 @@ dependencies {
 }
 
 tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
  withType<Test>().configureEach {
  systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
  }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
 }

instrumentation/apache-httpclient/apache-httpclient-4.0/javaagent/build.gradle.kts

@@ -27,3 +27,13 @@ dependencies {
  library("org.apache.httpcomponents:httpclient:4.0")
  testCompileOnly("net.jcip:jcip-annotations:1.0")
 }
+
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
+}

instrumentation/apache-httpclient/apache-httpclient-4.3/library/build.gradle.kts

@@ -11,3 +11,13 @@ dependencies {
 
  latestDepTestLibrary("org.apache.httpcomponents:httpclient:4.+") // see apache-httpclient-5.0 module
 }
+
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
+}

instrumentation/apache-httpclient/apache-httpclient-5.0/javaagent/build.gradle.kts

@@ -13,3 +13,13 @@ muzzle {
 dependencies {
  library("org.apache.httpcomponents.client5:httpclient5:5.0")
 }
+
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
+}

instrumentation/armeria-1.3/javaagent/build.gradle.kts

@@ -21,7 +21,20 @@ dependencies {
 }
 
 tasks {
- test {
+ val testStableSemconv by registering(Test::class) {
+ filter {
+ includeTestsMatching("ArmeriaHttpClientTest")
+ }
+ include("**/ArmeriaHttpClientTest.*")
+
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ withType<Test>().configureEach {
  systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
  }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
 }

instrumentation/armeria-1.3/library/build.gradle.kts

@@ -10,7 +10,20 @@ dependencies {
 }
 
 tasks {
- test {
+ val testStableSemconv by registering(Test::class) {
+ filter {
+ includeTestsMatching("ArmeriaHttpClientTest")
+ }
+ include("**/ArmeriaHttpClientTest.*")
+
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ withType<Test>().configureEach {
  systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
  }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
 }

instrumentation/async-http-client/async-http-client-1.9/javaagent/build.gradle.kts

@@ -20,10 +20,20 @@ dependencies {
  testInstrumentation(project(":instrumentation:netty:netty-3.8:javaagent"))
 }
 
-tasks.withType<Test>().configureEach {
- // required on jdk17
- jvmArgs("--add-exports=java.base/sun.security.util=ALL-UNNAMED")
- jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ withType<Test>().configureEach {
+ // required on jdk17
+ jvmArgs("--add-exports=java.base/sun.security.util=ALL-UNNAMED")
+ jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
 
- systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+ systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
 }

instrumentation/async-http-client/async-http-client-2.0/javaagent/build.gradle.kts

@@ -23,6 +23,16 @@ otelJava {
  maxJavaVersionForTests.set(JavaVersion.VERSION_1_8)
 }
 
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
+}
+
 // async-http-client 2.0.0 does not work with Netty versions newer than this due to referencing an
 // internal file.
 if (!(findProperty("testLatestDeps") as Boolean)) {

instrumentation/google-http-client-1.19/javaagent/build.gradle.kts

@@ -15,3 +15,13 @@ muzzle {
 dependencies {
  library("com.google.http-client:google-http-client:1.19.0")
 }
+
+tasks {
+ val testStableSemconv by registering(Test::class) {
+ jvmArgs("-Dotel.semconv-stability.opt-in=http")
+ }
+
+ check {
+ dependsOn(testStableSemconv)
+ }
+}

instrumentation/google-http-client-1.19/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/googlehttpclient/AbstractGoogleHttpClientTest.java

@@ -95,13 +95,15 @@ void errorTracesWhenExceptionIsNotThrown() throws Exception {
  span.hasKind(SpanKind.CLIENT)
  .hasStatus(StatusData.error())
  .hasAttributesSatisfyingExactly(
- equalTo(SemanticAttributes.NET_PEER_NAME, "localhost"),
- satisfies(SemanticAttributes.NET_PEER_PORT, port -> port.isPositive()),
- equalTo(SemanticAttributes.HTTP_URL, uri.toString()),
- equalTo(SemanticAttributes.HTTP_METHOD, "GET"),
- equalTo(SemanticAttributes.HTTP_STATUS_CODE, 500),
+ equalTo(getAttributeKey(SemanticAttributes.NET_PEER_NAME), "localhost"),
  satisfies(
- SemanticAttributes.HTTP_RESPONSE_CONTENT_LENGTH,
+ getAttributeKey(SemanticAttributes.NET_PEER_PORT),
+ port -> port.isPositive()),
+ equalTo(getAttributeKey(SemanticAttributes.HTTP_URL), uri.toString()),
+ equalTo(getAttributeKey(SemanticAttributes.HTTP_METHOD), "GET"),
+ equalTo(getAttributeKey(SemanticAttributes.HTTP_STATUS_CODE), 500),
+ satisfies(
+ getAttributeKey(SemanticAttributes.HTTP_RESPONSE_CONTENT_LENGTH),
  length -> length.isPositive())),
  span -> span.hasKind(SpanKind.SERVER).hasParent(trace.getSpan(0))));
  }