Merge branch 'main' into renovate/errorproneversion

Author: laurit

docs/instrumentation-list.yaml

@@ -6942,6 +6942,52 @@ libraries:
           type: STRING
         - name: messaging.system
           type: STRING
+    - when: otel.instrumentation.kafka.experimental-span-attributes=true
+      spans:
+      - span_kind: CONSUMER
+        attributes:
+        - name: kafka.record.queue_time_ms
+          type: LONG
+        - name: messaging.batch.message_count
+          type: LONG
+        - name: messaging.client_id
+          type: STRING
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.destination.partition.id
+          type: STRING
+        - name: messaging.kafka.consumer.group
+          type: STRING
+        - name: messaging.kafka.message.key
+          type: STRING
+        - name: messaging.kafka.message.offset
+          type: LONG
+        - name: messaging.kafka.message.tombstone
+          type: BOOLEAN
+        - name: messaging.message.body.size
+          type: LONG
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.system
+          type: STRING
+      - span_kind: PRODUCER
+        attributes:
+        - name: messaging.client_id
+          type: STRING
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.destination.partition.id
+          type: STRING
+        - name: messaging.kafka.message.key
+          type: STRING
+        - name: messaging.kafka.message.offset
+          type: LONG
+        - name: messaging.kafka.message.tombstone
+          type: BOOLEAN
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.system
+          type: STRING
   - name: kafka-clients-2.6
     display_name: Apache Kafka Client
     description: This standalone instrumentation enables messaging spans for Kafka

instrumentation-api-incubator/build.gradle.kts

@@ -1,6 +1,4 @@
 plugins {
-  id("org.xbib.gradle.plugin.jflex")
-
   id("otel.java-conventions")
   id("otel.animalsniffer-conventions")
   id("otel.jacoco-conventions")
@@ -10,7 +8,11 @@ plugins {
 
 group = "io.opentelemetry.instrumentation"
 
+val jflex = configurations.create("jflex")
+
 dependencies {
+  jflex("de.jflex:jflex:1.9.1")
+
   api("io.opentelemetry.semconv:opentelemetry-semconv")
   api(project(":instrumentation-api"))
   api("io.opentelemetry:opentelemetry-api-incubator")
@@ -24,6 +26,42 @@ dependencies {
   testImplementation("io.opentelemetry.semconv:opentelemetry-semconv-incubating")
 }
 
+val jflexSourceDir = layout.projectDirectory.dir("src/main/jflex")
+val jflexOutputDir = layout.buildDirectory.dir("generated/sources/jflex")
+
+val generateJflex by tasks.registering(JavaExec::class) {
+  classpath(jflex)
+  mainClass.set("jflex.Main")
+
+  inputs.dir(jflexSourceDir)
+  outputs.dir(jflexOutputDir)
+
+  val sourceDir = jflexSourceDir
+  val outputDirProvider = jflexOutputDir
+
+  doFirst {
+    val outputDir = outputDirProvider.get().asFile
+    outputDir.mkdirs()
+    val specFile = sourceDir.asFile.resolve("SqlSanitizer.jflex")
+    args(
+      "-d",
+      outputDir.absolutePath,
+      "--nobak",
+      specFile.absolutePath,
+    )
+  }
+}
+
+sourceSets {
+  main {
+    java.srcDir(jflexOutputDir)
+  }
+}
+
+tasks.compileJava {
+  dependsOn(generateJflex)
+}
+
 tasks {
   // exclude auto-generated code
   named<Checkstyle>("checkstyleMain") {
@@ -38,7 +76,11 @@ tasks {
   }
 
   sourcesJar {
-    dependsOn("generateJflex")
+    dependsOn(generateJflex)
+    // Avoid configuration cache issue by not capturing task reference
+    from("src/main/jflex") {
+      include("**/*.java")
+    }
   }
 
   val testStableSemconv by registering(Test::class) {

instrumentation/spring/spring-data/spring-data-3.0/kotlin-testing/src/test/kotlin/io/opentelemetry/javaagent/instrumentation/spring/data/v3_0/KotlinSpringDataTest.kt

@@ -52,7 +52,7 @@ class KotlinSpringDataTest {
       trace.hasSpansSatisfyingExactly({
         it.hasName("CustomerRepository.findById").hasNoParent()
       }, {
-        it.hasName("SELECT db.customer").hasParent(trace.getSpan(0))
+        it.hasName("SELECT db.CUSTOMER").hasParent(trace.getSpan(0))
       })
     })
   }

instrumentation/spring/spring-data/spring-data-3.0/kotlin-testing/src/test/kotlin/io/opentelemetry/javaagent/instrumentation/spring/data/v3_0/repository/Customer.kt

@@ -9,8 +9,8 @@ import org.springframework.data.annotation.Id
 import org.springframework.data.relational.core.mapping.Column
 import org.springframework.data.relational.core.mapping.Table
 
-@Table("customer")
+@Table("CUSTOMER")
 data class Customer(
-  @Id @Column("id") val id: Long,
-  @Column("name") val name: String,
+  @Id @Column("ID") val id: Long,
+  @Column("NAME") val name: String,
 )

instrumentation/spring/spring-data/spring-data-3.0/kotlin-testing/src/test/kotlin/io/opentelemetry/javaagent/instrumentation/spring/data/v3_0/repository/PersistenceConfig.kt

@@ -42,8 +42,8 @@ class PersistenceConfig {
     initializer.setDatabasePopulator(
       ResourceDatabasePopulator(
         ByteArrayResource(
-          ("CREATE TABLE customer (id INT PRIMARY KEY, name VARCHAR(100) NOT NULL);" +
-            "INSERT INTO customer (id, name) VALUES ('1', 'Name');")
+          ("CREATE TABLE CUSTOMER (ID INT PRIMARY KEY, NAME VARCHAR(100) NOT NULL);" +
+            "INSERT INTO CUSTOMER (ID, NAME) VALUES ('1', 'Name');")
             .toByteArray(StandardCharsets.UTF_8)
         )
       )

instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/HeaderUtil.java renamed to instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/HeaderUtil.java

@@ -3,14 +3,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.webflux.v5_3;
+package io.opentelemetry.instrumentation.spring.web.v3_1;
 
 import static java.util.Collections.emptyList;
 
 import java.lang.invoke.MethodHandle;
 import java.lang.invoke.MethodHandles;
 import java.lang.invoke.MethodType;
 import java.util.List;
+import java.util.Map;
 import javax.annotation.Nullable;
 import org.springframework.http.HttpHeaders;
 
@@ -19,14 +20,7 @@ class HeaderUtil {
 
   static {
     // since spring web 7.0
-    MethodHandle methodHandle =
-        findGetHeadersMethod(MethodType.methodType(List.class, String.class, List.class));
-    if (methodHandle == null) {
-      // up to spring web 7.0
-      methodHandle =
-          findGetHeadersMethod(MethodType.methodType(Object.class, Object.class, Object.class));
-    }
-    GET_HEADERS = methodHandle;
+    GET_HEADERS = findGetHeadersMethod(MethodType.methodType(List.class, String.class, List.class));
   }
 
   private static MethodHandle findGetHeadersMethod(MethodType methodType) {
@@ -37,9 +31,16 @@ private static MethodHandle findGetHeadersMethod(MethodType methodType) {
     }
   }
 
-  @SuppressWarnings("unchecked") // casting MethodHandle.invoke result
+  // before spring web 7.0 HttpHeaders implements Map<String, List<String>>, this triggers
+  // errorprone BadInstanceof warning since errorpone is not aware that this instanceof check does
+  // not pass with spring web 7.0+
+  @SuppressWarnings({"unchecked", "BadInstanceof"})
   static List<String> getHeader(HttpHeaders headers, String name) {
-    if (GET_HEADERS != null) {
+    if (headers instanceof Map) {
+      // before spring web 7.0
+      return ((Map<String, List<String>>) headers).getOrDefault(name, emptyList());
+    } else if (GET_HEADERS != null) {
+      // spring web 7.0
       try {
         return (List<String>) GET_HEADERS.invoke(headers, name, emptyList());
       } catch (Throwable t) {

instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/SpringWebHttpAttributesGetter.java

@@ -5,15 +5,12 @@
 
 package io.opentelemetry.instrumentation.spring.web.v3_1;
 
-import static java.util.Collections.emptyList;
-
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesGetter;
 import java.lang.invoke.MethodHandle;
 import java.lang.invoke.MethodHandles;
 import java.lang.invoke.MethodType;
 import java.util.List;
 import javax.annotation.Nullable;
-import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpRequest;
 import org.springframework.http.client.ClientHttpResponse;
 
@@ -23,7 +20,6 @@ enum SpringWebHttpAttributesGetter
 
   @Nullable private static final MethodHandle GET_STATUS_CODE;
   @Nullable private static final MethodHandle STATUS_CODE_VALUE;
-  @Nullable private static final MethodHandle GET_HEADERS;
 
   static {
     MethodHandles.Lookup lookup = MethodHandles.publicLookup();
@@ -58,24 +54,6 @@ enum SpringWebHttpAttributesGetter
 
     GET_STATUS_CODE = getStatusCode;
     STATUS_CODE_VALUE = statusCodeValue;
-
-    // since spring web 7.0
-    MethodHandle methodHandle =
-        findGetHeadersMethod(MethodType.methodType(List.class, String.class, List.class));
-    if (methodHandle == null) {
-      // up to spring web 7.0
-      methodHandle =
-          findGetHeadersMethod(MethodType.methodType(Object.class, Object.class, Object.class));
-    }
-    GET_HEADERS = methodHandle;
-  }
-
-  private static MethodHandle findGetHeadersMethod(MethodType methodType) {
-    try {
-      return MethodHandles.lookup().findVirtual(HttpHeaders.class, "getOrDefault", methodType);
-    } catch (Throwable t) {
-      return null;
-    }
   }
 
   @Override
@@ -91,19 +69,7 @@ public String getUrlFull(HttpRequest httpRequest) {
 
   @Override
   public List<String> getHttpRequestHeader(HttpRequest httpRequest, String name) {
-    return getHeader(httpRequest.getHeaders(), name);
-  }
-
-  @SuppressWarnings("unchecked") // casting MethodHandle.invoke result
-  private static List<String> getHeader(HttpHeaders headers, String name) {
-    if (GET_HEADERS != null) {
-      try {
-        return (List<String>) GET_HEADERS.invoke(headers, name, emptyList());
-      } catch (Throwable t) {
-        // ignore
-      }
-    }
-    return emptyList();
+    return HeaderUtil.getHeader(httpRequest.getHeaders(), name);
   }
 
   @Override
@@ -125,7 +91,7 @@ public Integer getHttpResponseStatusCode(
   @Override
   public List<String> getHttpResponseHeader(
       HttpRequest httpRequest, ClientHttpResponse clientHttpResponse, String name) {
-    return getHeader(clientHttpResponse.getHeaders(), name);
+    return HeaderUtil.getHeader(clientHttpResponse.getHeaders(), name);
   }
 
   @Override

instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/WebfluxServerHttpAttributesGetter.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.spring.webflux.v5_3;
 
 import io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesGetter;
+import io.opentelemetry.instrumentation.spring.webflux.v5_3.internal.HeaderUtil;
 import java.lang.invoke.MethodHandle;
 import java.lang.invoke.MethodHandles;
 import java.lang.invoke.MethodType;

instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/WebfluxTextMapGetter.java

@@ -8,6 +8,7 @@
 import static java.util.Collections.emptyIterator;
 
 import io.opentelemetry.context.propagation.TextMapGetter;
+import io.opentelemetry.instrumentation.spring.webflux.v5_3.internal.HeaderUtil;
 import java.util.Iterator;
 import javax.annotation.Nullable;
 import org.springframework.web.server.ServerWebExchange;

instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/internal/HeaderUtil.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.webflux.v5_3.internal;
+
+import static java.util.Collections.emptyList;
+
+import java.lang.invoke.MethodHandle;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodType;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nullable;
+import org.springframework.http.HttpHeaders;
+
+/**
+ * This class is internal and experimental. Its APIs are unstable and can change at any time. Its
+ * APIs (or a version of them) may be promoted to the public stable API in the future, but no
+ * guarantees are made.
+ */
+public final class HeaderUtil {
+  @Nullable private static final MethodHandle GET_HEADERS;
+
+  static {
+    // since spring web 7.0
+    GET_HEADERS = findGetHeadersMethod(MethodType.methodType(List.class, String.class, List.class));
+  }
+
+  private static MethodHandle findGetHeadersMethod(MethodType methodType) {
+    try {
+      return MethodHandles.lookup().findVirtual(HttpHeaders.class, "getOrDefault", methodType);
+    } catch (Throwable t) {
+      return null;
+    }
+  }
+
+  // before spring web 7.0 HttpHeaders implements Map<String, List<String>>, this triggers
+  // errorprone BadInstanceof warning since errorpone is not aware that this instanceof check does
+  // not pass with spring web 7.0+
+  @SuppressWarnings({"unchecked", "BadInstanceof"})
+  public static List<String> getHeader(HttpHeaders headers, String name) {
+    if (headers instanceof Map) {
+      // before spring web 7.0
+      return ((Map<String, List<String>>) headers).getOrDefault(name, emptyList());
+    } else if (GET_HEADERS != null) {
+      // spring web 7.0
+      try {
+        return (List<String>) GET_HEADERS.invoke(headers, name, emptyList());
+      } catch (Throwable t) {
+        // ignore
+      }
+    }
+    return emptyList();
+  }
+
+  private HeaderUtil() {}
+}