Add descriptions and metadata for spring modules (#14309)

Author: jaydeluca

docs/instrumentation-list.yaml

@@ -90,6 +90,31 @@ readonly INSTRUMENTATIONS=(
   "apache-dubbo-2.7:javaagent:testDubbo"
   "finagle-http-23.11:javaagent:test"
   "finatra-2.9:javaagent:test"
+  "spring:spring-batch-3.0:javaagent:test"
+  "spring:spring-data:spring-data-1.8:javaagent:test"
+  "spring:spring-integration-4.1:javaagent:test"
+  "spring:spring-integration-4.1:javaagent:testWithRabbitInstrumentation"
+  "spring:spring-integration-4.1:javaagent:testWithProducerInstrumentation"
+  "spring:spring-jms:spring-jms-2.0:javaagent:test"
+  "spring:spring-kafka-2.7:javaagent:test"
+  "spring:spring-kafka-2.7:javaagent:testNoReceiveTelemetry"
+  "spring:spring-pulsar-1.0:javaagent:test"
+  "spring:spring-rabbit-1.0:javaagent:test"
+  "spring:spring-rmi-4.0:javaagent:test"
+  "spring:spring-scheduling-3.1:javaagent:test"
+  "spring:spring-scheduling-3.1:javaagent:testExperimental"
+  "spring:spring-web:spring-web-3.1:library:test"
+  "spring:spring-web:spring-web-6.0:javaagent:test"
+  "spring:spring-webflux:spring-webflux-5.0:javaagent:test"
+  "spring:spring-webflux:spring-webflux-5.3:library:test"
+  "spring:spring-webmvc:spring-webmvc-3.1:javaagent:test"
+  "spring:spring-webmvc:spring-webmvc-3.1:javaagent:testExperimental"
+  "spring:spring-webmvc:spring-webmvc-5.3:library:test"
+  "spring:spring-webmvc:spring-webmvc-6.0:javaagent:test"
+  "spring:spring-webmvc:spring-webmvc-3.1:javaagent:testExperimental"
+  "spring:spring-webmvc:spring-webmvc-6.0:javaagent:test"
+  "spring:spring-webmvc:spring-webmvc-6.0:javaagent:testExperimental"
+  "openai:openai-java-1.1:javaagent:test"
 )
 
 readonly COLIMA_INSTRUMENTATIONS=(
@@ -221,7 +246,7 @@ run_gradle_tasks() {
 
   ./gradlew "${tasks[@]}" \
     -PcollectMetadata=true \
-    --rerun-tasks --continue
+    --rerun-tasks --continue --no-parallel
 }
 
 # Cleans any stray .telemetry directories left in the repo.

instrumentation-docs/collect.sh

@@ -28,7 +28,7 @@ In order to collect spans, add the `collectSpans` property (along with `collectM
 ```kotlin
 tasks {
   test {
-    systemProperty("collectMetadata", collectMetadata)
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
     systemProperty("collectSpans", true)
   }
 }

instrumentation-docs/readme.md

@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.docs;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
 import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetaData;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationModule;
@@ -76,7 +77,7 @@ private InstrumentationMetaData getMetadata(InstrumentationModule module)
     }
     try {
       return YamlHelper.metaDataParser(metadataFile);
-    } catch (ValueInstantiationException e) {
+    } catch (ValueInstantiationException | MismatchedInputException e) {
       logger.severe("Error parsing metadata file for " + module.getInstrumentationName());
       throw e;
     }

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/InstrumentationAnalyzer.java

@@ -24,7 +24,8 @@
 public class SpanParser {
 
   // We want to ignore test related attributes
-  private static final List<String> EXCLUDED_ATTRIBUTES = List.of("x-test-", "test-baggage-");
+  private static final List<String> EXCLUDED_ATTRIBUTES =
+      List.of("x-test-", "test-baggage-", "test_message");
 
   /**
    * Pull spans from the `.telemetry` directory, filter them by scope, and set them in the module.

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/parsers/SpanParser.java

@@ -4,7 +4,9 @@ configurations:
     type: boolean
     default: false
   - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
-    description: Enables experimental receive telemetry for AWS SDK instrumentation.
+    description: >
+      Enables experimental receive telemetry, which will cause consumers to start a new trace, with
+      only a span link connecting it to the producer trace.
     type: boolean
     default: false
   - name: otel.instrumentation.messaging.experimental.capture-headers

instrumentation/aws-sdk/aws-sdk-1.11/metadata.yaml

@@ -1,6 +1,8 @@
 configurations:
   - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
-    description: Enables experimental receive telemetry for AWS SDK instrumentation.
+    description: >
+      Enables experimental receive telemetry, which will cause consumers to start a new trace, with
+      only a span link connecting it to the producer trace.
     type: boolean
     default: false
   - name: otel.instrumentation.messaging.experimental.capture-headers

instrumentation/aws-sdk/aws-sdk-2.2/metadata.yaml

@@ -1,9 +1,9 @@
 configurations:
   - name: otel.instrumentation.common.experimental.view-telemetry.enabled
-    description: Enables experimental view telemetry.
+    description: Enables the creation of experimental view (INTERNAL) spans.
     type: boolean
     default: false
   - name: otel.instrumentation.common.experimental.controller-telemetry.enabled
-    description: Enables experimental controller telemetry.
+    description: Enables the creation of experimental controller (INTERNAL) spans.
     type: boolean
     default: false

instrumentation/dropwizard/dropwizard-views-0.7/metadata.yaml

@@ -15,6 +15,8 @@ configurations:
     type: list
     default: ''
   - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
-    description: Enables experimental receive telemetry for Kafka instrumentation.
+    description: >
+      Enables experimental receive telemetry, which will cause consumers to start a new trace, with
+      only a span link connecting it to the producer trace.
     type: boolean
     default: false

instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml

@@ -25,6 +25,9 @@ tasks {
   withType<Test>().configureEach {
     systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
     // TODO run tests both with and without genai message capture
+
     systemProperty("otel.instrumentation.genai.capture-message-content", "true")
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+    systemProperty("collectSpans", true)
   }
 }