Deprecate the 2-arg variant of HttpCommonAttributesGeter#statusCode() (…

…#6466)

* Deprecate the 2-arg variant of HttpCommonAttributesGeter#statusCode()

* fix liberty

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

@@ -63,10 +63,14 @@ default Long requestContentLengthUncompressed(REQUEST request, @Nullable RESPONS
    *
    * <p>This is called from {@link Instrumenter#end(Context, Object, Object, Throwable)}, only when
    * {@code response} is non-{@code null}.
+   *
+   * @deprecated This method is deprecated and will be removed in the next release.
    */
-  // TODO: deprecate this method and use the new one everywhere
+  @Deprecated
   @Nullable
-  Integer statusCode(REQUEST request, RESPONSE response);
+  default Integer statusCode(REQUEST request, RESPONSE response) {
+    throw new UnsupportedOperationException("This method is deprecated and will be removed");
+  }
 
   /**
    * Extracts the {@code http.status_code} span attribute.

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

@@ -19,6 +19,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import javax.annotation.Nullable;
 import org.junit.jupiter.api.Test;
 
 class HttpClientAttributesExtractorTest {
@@ -43,7 +44,8 @@ public List<String> requestHeader(Map<String, String> request, String name) {
     }
 
     @Override
-    public Integer statusCode(Map<String, String> request, Map<String, String> response) {
+    public Integer statusCode(
+        Map<String, String> request, Map<String, String> response, @Nullable Throwable error) {
       return Integer.parseInt(response.get("statusCode"));
     }
 

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

@@ -20,6 +20,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
+import javax.annotation.Nullable;
 import org.junit.jupiter.api.Test;
 
 class HttpServerAttributesExtractorTest {
@@ -59,7 +60,8 @@ public List<String> requestHeader(Map<String, String> request, String name) {
     }
 
     @Override
-    public Integer statusCode(Map<String, String> request, Map<String, String> response) {
+    public Integer statusCode(
+        Map<String, String> request, Map<String, String> response, @Nullable Throwable error) {
       String value = response.get("statusCode");
       return value == null ? null : Integer.parseInt(value);
     }

instrumentation-api/src/jmh/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterBenchmark.java

@@ -86,7 +86,7 @@ public String flavor(Void unused, @Nullable Void unused2) {
     }
 
     @Override
-    public Integer statusCode(Void unused, Void unused2) {
+    public Integer statusCode(Void unused, Void unused2, @Nullable Throwable error) {
       return 200;
     }
 

instrumentation/akka/akka-http-10.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkahttp/client/AkkaHttpClientAttributesGetter.java

@@ -36,7 +36,8 @@ public List<String> requestHeader(HttpRequest httpRequest, String name) {
   }
 
   @Override
-  public Integer statusCode(HttpRequest httpRequest, HttpResponse httpResponse) {
+  public Integer statusCode(
+      HttpRequest httpRequest, HttpResponse httpResponse, @Nullable Throwable error) {
     return httpResponse.status().intValue();
   }
 

instrumentation/akka/akka-http-10.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkahttp/server/AkkaHttpServerAttributesGetter.java

@@ -27,7 +27,8 @@ public List<String> requestHeader(HttpRequest request, String name) {
   }
 
   @Override
-  public Integer statusCode(HttpRequest request, HttpResponse httpResponse) {
+  public Integer statusCode(
+      HttpRequest request, HttpResponse httpResponse, @Nullable Throwable error) {
     return httpResponse.status().intValue();
   }
 

instrumentation/apache-httpasyncclient-4.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/apachehttpasyncclient/ApacheHttpAsyncClientHttpAttributesGetter.java

@@ -33,7 +33,8 @@ public List<String> requestHeader(ApacheHttpClientRequest request, String name)
 
   @Override
   @Nullable
-  public Integer statusCode(ApacheHttpClientRequest request, HttpResponse response) {
+  public Integer statusCode(
+      ApacheHttpClientRequest request, HttpResponse response, @Nullable Throwable error) {
     StatusLine statusLine = response.getStatusLine();
     return statusLine != null ? statusLine.getStatusCode() : null;
   }

instrumentation/apache-httpclient/apache-httpclient-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/apachehttpclient/v2_0/ApacheHttpClientHttpAttributesGetter.java

@@ -39,7 +39,7 @@ public List<String> requestHeader(HttpMethod request, String name) {
 
   @Override
   @Nullable
-  public Integer statusCode(HttpMethod request, HttpMethod response) {
+  public Integer statusCode(HttpMethod request, HttpMethod response, @Nullable Throwable error) {
     StatusLine statusLine = response.getStatusLine();
     return statusLine == null ? null : statusLine.getStatusCode();
   }

instrumentation/apache-httpclient/apache-httpclient-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/apachehttpclient/v4_0/ApacheHttpClientHttpAttributesGetter.java

@@ -31,7 +31,8 @@ public List<String> requestHeader(ApacheHttpClientRequest request, String name)
   }
 
   @Override
-  public Integer statusCode(ApacheHttpClientRequest request, HttpResponse response) {
+  public Integer statusCode(
+      ApacheHttpClientRequest request, HttpResponse response, @Nullable Throwable error) {
     return response.getStatusLine().getStatusCode();
   }
 

instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientHttpAttributesGetter.java

@@ -33,7 +33,8 @@ public List<String> requestHeader(ApacheHttpClientRequest request, String name)
   }
 
   @Override
-  public Integer statusCode(ApacheHttpClientRequest request, HttpResponse response) {
+  public Integer statusCode(
+      ApacheHttpClientRequest request, HttpResponse response, @Nullable Throwable error) {
     return response.getStatusLine().getStatusCode();
   }
 

instrumentation/apache-httpclient/apache-httpclient-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/apachehttpclient/v5_0/ApacheHttpClientHttpAttributesGetter.java

@@ -69,7 +69,7 @@ public List<String> requestHeader(HttpRequest request, String name) {
   }
 
   @Override
-  public Integer statusCode(HttpRequest request, HttpResponse response) {
+  public Integer statusCode(HttpRequest request, HttpResponse response, @Nullable Throwable error) {
     return response.getCode();
   }
 

instrumentation/armeria-1.3/library/src/main/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaHttpClientAttributesGetter.java

@@ -36,7 +36,7 @@ public List<String> requestHeader(RequestContext ctx, String name) {
 
   @Override
   @Nullable
-  public Integer statusCode(RequestContext ctx, RequestLog requestLog) {
+  public Integer statusCode(RequestContext ctx, RequestLog requestLog, @Nullable Throwable error) {
     HttpStatus status = requestLog.responseHeaders().status();
     if (!status.equals(HttpStatus.UNKNOWN)) {
       return status.code();

instrumentation/armeria-1.3/library/src/main/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaHttpServerAttributesGetter.java

@@ -43,7 +43,7 @@ public List<String> requestHeader(RequestContext ctx, String name) {
 
   @Override
   @Nullable
-  public Integer statusCode(RequestContext ctx, RequestLog requestLog) {
+  public Integer statusCode(RequestContext ctx, RequestLog requestLog, @Nullable Throwable error) {
     HttpStatus status = requestLog.responseHeaders().status();
     if (!status.equals(HttpStatus.UNKNOWN)) {
       return status.code();

instrumentation/async-http-client/async-http-client-1.9/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/asynchttpclient/v1_9/AsyncHttpClientHttpAttributesGetter.java

@@ -32,7 +32,7 @@ public List<String> requestHeader(Request request, String name) {
   }
 
   @Override
-  public Integer statusCode(Request request, Response response) {
+  public Integer statusCode(Request request, Response response, @Nullable Throwable error) {
     return response.getStatusCode();
   }
 

instrumentation/async-http-client/async-http-client-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/asynchttpclient/v2_0/AsyncHttpClientHttpAttributesGetter.java

@@ -30,7 +30,8 @@ public List<String> requestHeader(RequestContext requestContext, String name) {
   }
 
   @Override
-  public Integer statusCode(RequestContext requestContext, Response response) {
+  public Integer statusCode(
+      RequestContext requestContext, Response response, @Nullable Throwable error) {
     return response.getStatusCode();
   }
 

instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkHttpAttributesGetter.java

@@ -40,7 +40,7 @@ public List<String> requestHeader(Request<?> request, String name) {
   }
 
   @Override
-  public Integer statusCode(Request<?> request, Response<?> response) {
+  public Integer statusCode(Request<?> request, Response<?> response, @Nullable Throwable error) {
     return response.getHttpResponse().getStatusCode();
   }
 

instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AwsSdkHttpAttributesGetter.java

@@ -47,7 +47,8 @@ public List<String> requestHeader(ExecutionAttributes request, String name) {
   }
 
   @Override
-  public Integer statusCode(ExecutionAttributes request, SdkHttpResponse response) {
+  public Integer statusCode(
+      ExecutionAttributes request, SdkHttpResponse response, @Nullable Throwable error) {
     return response.statusCode();
   }
 

instrumentation/google-http-client-1.19/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/googlehttpclient/GoogleHttpClientHttpAttributesGetter.java

@@ -37,7 +37,8 @@ public String flavor(HttpRequest httpRequest, @Nullable HttpResponse httpRespons
   }
 
   @Override
-  public Integer statusCode(HttpRequest httpRequest, HttpResponse httpResponse) {
+  public Integer statusCode(
+      HttpRequest httpRequest, HttpResponse httpResponse, @Nullable Throwable error) {
     return httpResponse.getStatusCode();
   }
 

instrumentation/grizzly-2.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/grizzly/GrizzlyHttpAttributesGetter.java

@@ -37,7 +37,8 @@ private static List<String> toHeaderList(Iterable<String> values) {
   }
 
   @Override
-  public Integer statusCode(HttpRequestPacket request, HttpResponsePacket response) {
+  public Integer statusCode(
+      HttpRequestPacket request, HttpResponsePacket response, @Nullable Throwable error) {
     return response.getStatus();
   }
 

instrumentation/http-url-connection/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/httpurlconnection/HttpUrlHttpAttributesGetter.java

@@ -39,7 +39,8 @@ public String flavor(HttpURLConnection connection, @Nullable Integer statusCode)
   }
 
   @Override
-  public Integer statusCode(HttpURLConnection connection, Integer statusCode) {
+  public Integer statusCode(
+      HttpURLConnection connection, Integer statusCode, @Nullable Throwable error) {
     return statusCode;
   }
 

instrumentation/java-http-client/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/httpclient/JdkHttpAttributesGetter.java

@@ -31,7 +31,8 @@ public List<String> requestHeader(HttpRequest httpRequest, String name) {
   }
 
   @Override
-  public Integer statusCode(HttpRequest httpRequest, HttpResponse<?> httpResponse) {
+  public Integer statusCode(
+      HttpRequest httpRequest, HttpResponse<?> httpResponse, @Nullable Throwable error) {
     return httpResponse.statusCode();
   }
 

instrumentation/jaxrs-client/jaxrs-client-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jaxrsclient/v1_1/JaxRsClientHttpAttributesGetter.java

@@ -48,7 +48,8 @@ public String flavor(ClientRequest httpRequest, @Nullable ClientResponse httpRes
   }
 
   @Override
-  public Integer statusCode(ClientRequest httpRequest, ClientResponse httpResponse) {
+  public Integer statusCode(
+      ClientRequest httpRequest, ClientResponse httpResponse, @Nullable Throwable error) {
     return httpResponse.getStatus();
   }
 

instrumentation/jetty-httpclient/jetty-httpclient-9.2/library/src/main/java/io/opentelemetry/instrumentation/jetty/httpclient/v9_2/internal/JettyClientHttpAttributesGetter.java

@@ -61,7 +61,7 @@ public String flavor(Request request, @Nullable Response response) {
   }
 
   @Override
-  public Integer statusCode(Request request, Response response) {
+  public Integer statusCode(Request request, Response response, @Nullable Throwable error) {
     return response.getStatus();
   }
 

instrumentation/jetty/jetty-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jetty/common/JettyHelper.java

@@ -40,8 +40,7 @@ public void end(
       throwable = errorException(request);
     }
 
-    ServletResponseContext<RESPONSE> responseContext =
-        new ServletResponseContext<>(response, throwable);
+    ServletResponseContext<RESPONSE> responseContext = new ServletResponseContext<>(response);
     if (throwable != null || mustEndOnHandlerMethodExit(request)) {
       instrumenter.end(context, requestContext, responseContext, throwable);
     }

instrumentation/ktor/ktor-1.0/library/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v1_0/KtorHttpServerAttributesGetter.kt

@@ -23,7 +23,7 @@ internal enum class KtorHttpServerAttributesGetter :
     return request.headers.getAll(name) ?: emptyList()
   }
 
-  override fun statusCode(request: ApplicationRequest, response: ApplicationResponse): Int? {
+  override fun statusCode(request: ApplicationRequest, response: ApplicationResponse, error: Throwable?): Int? {
     return response.status()?.value
   }
 

instrumentation/ktor/ktor-2.0/library/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/KtorHttpServerAttributesGetter.kt

@@ -23,7 +23,7 @@ internal enum class KtorHttpServerAttributesGetter :
     return request.headers.getAll(name) ?: emptyList()
   }
 
-  override fun statusCode(request: ApplicationRequest, response: ApplicationResponse): Int? {
+  override fun statusCode(request: ApplicationRequest, response: ApplicationResponse, error: Throwable?): Int? {
     return response.status()?.value
   }
 

instrumentation/kubernetes-client-7.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kubernetesclient/KubernetesHttpAttributesGetter.java

@@ -38,7 +38,8 @@ public String flavor(Request request, @Nullable ApiResponse<?> apiResponse) {
   }
 
   @Override
-  public Integer statusCode(Request request, ApiResponse<?> apiResponse) {
+  public Integer statusCode(
+      Request request, ApiResponse<?> apiResponse, @Nullable Throwable error) {
     return apiResponse.getStatusCode();
   }
 

instrumentation/liberty/liberty-20.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/liberty/LibertyHelper.java

@@ -39,8 +39,7 @@ public void end(
       throwable = AppServerBridge.getException(context);
     }
 
-    ServletResponseContext<RESPONSE> responseContext =
-        new ServletResponseContext<>(response, throwable);
+    ServletResponseContext<RESPONSE> responseContext = new ServletResponseContext<>(response);
     if (throwable != null || mustEndOnHandlerMethodExit(request)) {
       instrumenter.end(context, requestContext, responseContext, throwable);
     }

instrumentation/liberty/liberty-dispatcher-20.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/liberty/dispatcher/LibertyDispatcherHttpAttributesGetter.java

@@ -38,7 +38,8 @@ public String flavor(LibertyRequest libertyRequest) {
 
   @Override
   @Nullable
-  public Integer statusCode(LibertyRequest libertyRequest, LibertyResponse libertyResponse) {
+  public Integer statusCode(
+      LibertyRequest libertyRequest, LibertyResponse libertyResponse, @Nullable Throwable error) {
     return libertyResponse.getStatus();
   }
 

instrumentation/netty/netty-3.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/netty/v3_8/client/NettyHttpClientAttributesGetter.java

@@ -59,7 +59,8 @@ public List<String> requestHeader(HttpRequestAndChannel requestAndChannel, Strin
   }
 
   @Override
-  public Integer statusCode(HttpRequestAndChannel requestAndChannel, HttpResponse response) {
+  public Integer statusCode(
+      HttpRequestAndChannel requestAndChannel, HttpResponse response, @Nullable Throwable error) {
     return response.getStatus().getCode();
   }
 

instrumentation/netty/netty-3.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/netty/v3_8/server/NettyHttpServerAttributesGetter.java

@@ -27,7 +27,8 @@ public List<String> requestHeader(HttpRequestAndChannel requestAndChannel, Strin
   }
 
   @Override
-  public Integer statusCode(HttpRequestAndChannel requestAndChannel, HttpResponse response) {
+  public Integer statusCode(
+      HttpRequestAndChannel requestAndChannel, HttpResponse response, @Nullable Throwable error) {
     return response.getStatus().getCode();
   }
 

instrumentation/netty/netty-4-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/netty/v4/common/client/NettyHttpClientAttributesGetter.java

@@ -59,7 +59,8 @@ public List<String> requestHeader(HttpRequestAndChannel requestAndChannel, Strin
   }
 
   @Override
-  public Integer statusCode(HttpRequestAndChannel requestAndChannel, HttpResponse response) {
+  public Integer statusCode(
+      HttpRequestAndChannel requestAndChannel, HttpResponse response, @Nullable Throwable error) {
     return response.getStatus().code();
   }
 

instrumentation/netty/netty-4-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/netty/v4/common/server/NettyHttpServerAttributesGetter.java

@@ -27,7 +27,8 @@ public List<String> requestHeader(HttpRequestAndChannel requestAndChannel, Strin
   }
 
   @Override
-  public Integer statusCode(HttpRequestAndChannel requestAndChannel, HttpResponse response) {
+  public Integer statusCode(
+      HttpRequestAndChannel requestAndChannel, HttpResponse response, @Nullable Throwable error) {
     return response.getStatus().code();
   }
 

instrumentation/okhttp/okhttp-2.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/okhttp/v2_2/OkHttp2HttpAttributesGetter.java

@@ -30,7 +30,7 @@ public List<String> requestHeader(Request request, String name) {
   }
 
   @Override
-  public Integer statusCode(Request request, Response response) {
+  public Integer statusCode(Request request, Response response, @Nullable Throwable error) {
     return response.code();
   }
 

instrumentation/okhttp/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/okhttp/v3_0/OkHttpAttributesGetter.java

@@ -53,7 +53,7 @@ public String flavor(Request request, @Nullable Response response) {
   }
 
   @Override
-  public Integer statusCode(Request request, Response response) {
+  public Integer statusCode(Request request, Response response, @Nullable Throwable error) {
     return response.code();
   }
 

instrumentation/opentelemetry-instrumentation-api/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/testing/MockHttpServerAttributesGetter.java

@@ -29,7 +29,7 @@ public List<String> requestHeader(String s, String name) {
 
   @Nullable
   @Override
-  public Integer statusCode(String s, Void unused) {
+  public Integer statusCode(String s, Void unused, @Nullable Throwable error) {
     return null;
   }
 

instrumentation/play/play-ws/play-ws-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/playws/PlayWsClientHttpAttributesGetter.java

@@ -31,7 +31,7 @@ public List<String> requestHeader(Request request, String name) {
   }
 
   @Override
-  public Integer statusCode(Request request, Response response) {
+  public Integer statusCode(Request request, Response response, @Nullable Throwable error) {
     return response.getStatusCode();
   }
 

instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/RatpackHttpAttributesGetter.java

@@ -77,7 +77,7 @@ public String serverName(Request request) {
   }
 
   @Override
-  public Integer statusCode(Request request, Response response) {
+  public Integer statusCode(Request request, Response response, @Nullable Throwable error) {
     return response.getStatus().getCode();
   }
 

instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/RatpackHttpClientAttributesGetter.java

@@ -39,7 +39,8 @@ public List<String> requestHeader(RequestSpec requestSpec, String name) {
   }
 
   @Override
-  public Integer statusCode(RequestSpec requestSpec, HttpResponse httpResponse) {
+  public Integer statusCode(
+      RequestSpec requestSpec, HttpResponse httpResponse, @Nullable Throwable error) {
     return httpResponse.getStatusCode();
   }