Code review sweep (run 24980313637) (open-telemetry#18335)

Co-authored-by: otelbot <197425009+otelbot@users.noreply.github.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

Author: otelbot[bot]

instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/src/main/java/io/opentelemetry/instrumentation/jetty/httpclient/v12_0/TracingHttpRequest.java

@@ -12,6 +12,7 @@
 import io.opentelemetry.instrumentation.jetty.httpclient.v12_0.internal.JettyClientWrapUtil;
 import java.net.URI;
 import java.nio.ByteBuffer;
+import javax.annotation.Nullable;
 import org.eclipse.jetty.client.HttpClient;
 import org.eclipse.jetty.client.Request;
 import org.eclipse.jetty.client.Response;
@@ -21,9 +22,9 @@
 class TracingHttpRequest extends HttpRequest {
 
   private final Instrumenter<Request, Response> instrumenter;
-  private Context parentContext;
+  @Nullable private Context parentContext;
 
-  public TracingHttpRequest(
+  TracingHttpRequest(
       HttpClient client,
       HttpConversation conversation,
       URI uri,
@@ -40,6 +41,7 @@ public void send(Response.CompleteListener listener) {
     super.send(JettyClientWrapUtil.wrapTheListener(listener, parentContext));
   }
 
+  @Nullable
   private Scope openScope() {
     return parentContext != null ? parentContext.makeCurrent() : null;
   }

instrumentation/jetty-httpclient/jetty-httpclient-12.0/testing/src/main/java/io/opentelemetry/instrumentation/jetty/httpclient/v12_0/AbstractJettyClient12Test.java

@@ -59,8 +59,8 @@ void after() throws Exception {
   protected void configure(HttpClientTestOptions.Builder optionsBuilder) {
     // disable redirect tests
     optionsBuilder.disableTestRedirects();
-    // jetty 12 does not support to reuse request
-    // use request.send() twice will block the program infinitely
+    // Jetty 12 does not support reusing requests.
+    // Calling request.send() twice blocks indefinitely.
     optionsBuilder.disableTestReusedRequest();
     optionsBuilder.spanEndsAfterBody();
   }

instrumentation/jetty-httpclient/jetty-httpclient-9.2/javaagent/build.gradle.kts

@@ -12,12 +12,12 @@ muzzle {
 }
 
 // Jetty client 9.2 is the best starting point, HttpClient.send() is stable there
-val jettyVers_base9 = "9.2.0.v20140526"
+val jettyVersBase9 = "9.2.0.v20140526"
 
 dependencies {
   implementation(project(":instrumentation:jetty-httpclient:jetty-httpclient-9.2:library"))
 
-  library("org.eclipse.jetty:jetty-client:$jettyVers_base9")
+  library("org.eclipse.jetty:jetty-client:$jettyVersBase9")
 
   testInstrumentation(project(":instrumentation:jetty-httpclient:jetty-httpclient-12.0:javaagent"))
 

instrumentation/jetty-httpclient/jetty-httpclient-9.2/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jetty/httpclient/v9_2/JettyHttpClient9InstrumentationModule.java

@@ -28,8 +28,7 @@ public List<TypeInstrumentation> typeInstrumentations() {
 
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
-    return hasClassesNamed(
-        // added in 9.2
-        "org.eclipse.jetty.client.util.AbstractTypedContentProvider");
+    // added in 9.2
+    return hasClassesNamed("org.eclipse.jetty.client.util.AbstractTypedContentProvider");
   }
 }

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

@@ -84,7 +84,7 @@ private static void wrapRequestListeners(
     ListIterator<Request.RequestListener> iterator = requestListeners.listIterator();
 
     while (iterator.hasNext()) {
-      List<Class<?>> interfaces = new ArrayList<>();
+      List<Class<?>> interfaces = new ArrayList<>(REQUEST_LISTENER_INTERFACES.length);
       Request.RequestListener listener = iterator.next();
 
       Class<?> listenerClass = listener.getClass();

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

@@ -6,7 +6,6 @@
 package io.opentelemetry.instrumentation.jetty.httpclient.v9_2.internal;
 
 import static java.util.Arrays.asList;
-import static java.util.stream.Collectors.toList;
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.Scope;
@@ -60,10 +59,11 @@ private JettyClientWrapUtil() {}
    */
   public static List<Response.ResponseListener> wrapResponseListeners(
       Context parentContext, List<Response.ResponseListener> listeners) {
-
-    return listeners.stream()
-        .map(listener -> wrapTheListener(listener, parentContext))
-        .collect(toList());
+    List<Response.ResponseListener> wrappedListeners = new ArrayList<>(listeners.size());
+    for (Response.ResponseListener listener : listeners) {
+      wrappedListeners.add(wrapTheListener(listener, parentContext));
+    }
+    return wrappedListeners;
   }
 
   private static Response.ResponseListener wrapTheListener(
@@ -73,7 +73,7 @@ private static Response.ResponseListener wrapTheListener(
     }
 
     Class<?> listenerClass = listener.getClass();
-    List<Class<?>> interfaces = new ArrayList<>();
+    List<Class<?>> interfaces = new ArrayList<>(LISTENER_INTERFACES.length);
     for (Class<?> type : LISTENER_INTERFACES) {
       if (type.isInstance(listener)) {
         interfaces.add(type);

instrumentation/jetty-httpclient/jetty-httpclient-9.2/metadata.yaml

@@ -6,16 +6,19 @@ semantic_conventions:
 library_link: https://eclipse.dev/jetty/
 configurations:
   - name: otel.instrumentation.http.known-methods
+    declarative_name: java.common.http.known_methods
     description: >
       Configures the instrumentation to recognize an alternative set of HTTP request methods. All
       other methods will be treated as `_OTHER`.
     type: list
     default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
   - name: otel.instrumentation.http.client.capture-request-headers
+    declarative_name: general.http.client.request_captured_headers
     description: List of HTTP request headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.http.client.capture-response-headers
+    declarative_name: general.http.client.response_captured_headers
     description: List of HTTP response headers to capture in HTTP client telemetry.
     type: list
     default: ""
@@ -24,13 +27,15 @@ configurations:
     type: map
     default: ""
   - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    declarative_name: java.common.http.client.emit_experimental_telemetry/development
     description: >
       Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
       and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
       `http.client.response.size` metrics.
     type: boolean
     default: false
   - name: otel.instrumentation.sanitization.url.experimental.sensitive-query-parameters
+    declarative_name: general.sanitization.url.sensitive_query_parameters/development
     description: List of URL query parameter names whose values are redacted in URL attributes. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
     type: list
     default: "AWSAccessKeyId,Signature,sig,X-Goog-Signature"

instrumentation/jetty-httpclient/jetty-httpclient-9.2/testing/src/main/java/io/opentelemetry/instrumentation/jetty/httpclient/v9_2/AbstractJettyClient9Test.java

@@ -7,6 +7,7 @@
 
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
 import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpClientTest;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientResult;
 import io.opentelemetry.instrumentation.testing.junit.http.HttpClientTestOptions;
@@ -18,13 +19,15 @@
 import org.eclipse.jetty.client.api.Request;
 import org.eclipse.jetty.client.api.Response;
 import org.eclipse.jetty.util.ssl.SslContextFactory;
-import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.api.extension.RegisterExtension;
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 public abstract class AbstractJettyClient9Test extends AbstractHttpClientTest<Request> {
 
+  @RegisterExtension static final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
+
   private HttpClient client;
   private HttpClient httpsClient;
 
@@ -34,17 +37,13 @@ void before() throws Exception {
     client = createStandardClient();
     client.setConnectTimeout(CONNECTION_TIMEOUT.toMillis());
     client.start();
+    cleanup.deferCleanup(client::stop);
 
     SslContextFactory tlsCtx = new SslContextFactory();
     httpsClient = createHttpsClient(tlsCtx);
     httpsClient.setFollowRedirects(false);
     httpsClient.start();
-  }
-
-  @AfterEach
-  void after() throws Exception {
-    client.stop();
-    httpsClient.stop();
+    cleanup.deferCleanup(httpsClient::stop);
   }
 
   @Override
@@ -55,7 +54,7 @@ protected void configure(HttpClientTestOptions.Builder optionsBuilder) {
 
   @Override
   public Request buildRequest(String method, URI uri, Map<String, String> headers) {
-    HttpClient theClient = uri.getScheme().equalsIgnoreCase("https") ? httpsClient : client;
+    HttpClient theClient = "https".equalsIgnoreCase(uri.getScheme()) ? httpsClient : client;
     Request request = theClient.newRequest(uri).method(method).agent("Jetty");
     headers.forEach(request::header);
 

instrumentation/jetty/jetty-11.0/metadata.yaml

@@ -6,20 +6,24 @@ semantic_conventions:
 library_link: https://eclipse.dev/jetty/
 configurations:
   - name: otel.instrumentation.http.known-methods
+    declarative_name: java.common.http.known_methods
     description: >
       Configures the instrumentation to recognize an alternative set of HTTP request methods. All
       other methods will be treated as `_OTHER`.
     type: list
     default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
   - name: otel.instrumentation.http.server.capture-request-headers
+    declarative_name: general.http.server.request_captured_headers
     description: List of HTTP request headers to capture in HTTP server telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.http.server.capture-response-headers
+    declarative_name: general.http.server.response_captured_headers
     description: List of HTTP response headers to capture in HTTP server telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.http.server.emit-experimental-telemetry
+    declarative_name: java.common.http.server.emit_experimental_telemetry/development
     description: >
       Enable the capture of experimental HTTP server telemetry. Adds the `http.request.body.size`
       and `http.response.body.size` attributes to spans, and records `http.server.request.size` and

instrumentation/jetty/jetty-12.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jetty/v12_0/Jetty12Helper.java

@@ -14,18 +14,18 @@
 import org.eclipse.jetty.server.Request;
 import org.eclipse.jetty.server.Response;
 
-public class Jetty12Helper {
+class Jetty12Helper {
   private final Instrumenter<Request, Response> instrumenter;
 
   Jetty12Helper(Instrumenter<Request, Response> instrumenter) {
     this.instrumenter = instrumenter;
   }
 
-  public boolean shouldStart(Context parentContext, Request request) {
+  boolean shouldStart(Context parentContext, Request request) {
     return instrumenter.shouldStart(parentContext, request);
   }
 
-  public Context start(Context parentContext, Request request, Response response) {
+  Context start(Context parentContext, Request request, Response response) {
     Context context = instrumenter.start(parentContext, request);
     request.addFailureListener(throwable -> end(context, request, response, throwable));
     // detect request completion
@@ -49,7 +49,7 @@ public void failed(Throwable throwable) {
     return context;
   }
 
-  public void end(Context context, Request request, Response response, @Nullable Throwable error) {
+  void end(Context context, Request request, Response response, @Nullable Throwable error) {
     error = AppServerBridge.getException(context, error);
     error = ServletAsyncContext.getAsyncException(context, error);