generate metadata

Author: AlixBa

docs/instrumentation-list.yaml

@@ -4102,6 +4102,59 @@ libraries:
     target_versions:
       javaagent:
       - org.mybatis:mybatis:[3.2.0,)
+  nats:
+  - name: nats-2.21
+    description: This instrumentation provides messaging spans for NATS
+    disabled_by_default: true
+    source_path: instrumentation/nats/nats-2.21
+    scope:
+      name: io.opentelemetry.nats-2.21
+    target_versions:
+      javaagent:
+      - io.nats:jnats:[2.17.2,)
+      library:
+      - io.nats:jnats:2.21.0
+    configurations:
+    - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
+      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
+      description: Allows configuring headers to capture as span attributes.
+      type: list
+      default: ''
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CONSUMER
+        attributes:
+        - name: messaging.client_id
+          type: STRING
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.header.captured_header
+          type: STRING_ARRAY
+        - 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.header.captured_header
+          type: STRING_ARRAY
+        - name: messaging.message.body.size
+          type: LONG
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.system
+          type: STRING
   netty:
   - name: netty-3.8
     source_path: instrumentation/netty/netty-3.8

instrumentation-docs/instrumentations.sh

@@ -137,6 +137,8 @@ readonly INSTRUMENTATIONS=(
   "grails-3.0:javaagent:test"
   "grizzly-2.3:javaagent:test"
   "gwt-2.0:javaagent:test"
+  "nats:nats-2.21:javaagent:test"
+  "nats:nats-2.21:javaagent:testExperimental"
 )
 
 #  Some instrumentation test suites don't run ARM, so we use colima to run them in an x86_64

instrumentation/nats/nats-2.21/javaagent/build.gradle.kts

@@ -18,20 +18,26 @@ dependencies {
   testImplementation(project(":instrumentation:nats:nats-2.21:testing"))
 }
 
+val collectMetadata = findProperty("collectMetadata")?.toString() ?: "false"
+
 tasks {
   val testExperimental by registering(Test::class) {
     filter {
       includeTestsMatching("NatsInstrumentationExperimentalTest")
     }
     jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
     jvmArgs("-Dotel.instrumentation.messaging.experimental.capture-headers=captured-header")
+
+    systemProperty("collectMetadata", collectMetadata)
   }
 
   test {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
     filter {
       excludeTestsMatching("NatsInstrumentationExperimentalTest")
     }
+
+    systemProperty("collectMetadata", collectMetadata)
   }
 
   check {

instrumentation/nats/nats-2.21/metadata.yaml

@@ -2,6 +2,12 @@ disabled_by_default: true
 description: This instrumentation provides messaging spans for NATS
 configurations:
   - name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
-    description: Enables experimental receive telemetry for NATS 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
+    description: Allows configuring headers to capture as span attributes.
+    type: list
+    default: ''