elasticsearch metadata

Author: jaydeluca

docs/instrumentation-list.yaml

@@ -1100,6 +1100,9 @@ libraries:
       default: false
   elasticsearch:
   - name: elasticsearch-api-client-7.16
+    description: This instrumentation provides client spans for Elasticsearch API
+      client requests for version 7 of the client. Versions 8.10 and later have native
+      support for OpenTelemetry.
     source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16
     scope:
       name: io.opentelemetry.elasticsearch-api-client-7.16
@@ -1122,6 +1125,21 @@ libraries:
         may contain personal or sensitive information.
       type: boolean
       default: false
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.system
+          type: STRING
+        - name: http.request.method
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
+        - name: url.full
+          type: STRING
   - name: elasticsearch-rest-6.4
     source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4
     scope:
@@ -1135,6 +1153,21 @@ libraries:
         Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.
       type: boolean
       default: false
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.system
+          type: STRING
+        - name: http.request.method
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
+        - name: url.full
+          type: STRING
   - name: elasticsearch-rest-7.0
     source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0
     scope:
@@ -1150,6 +1183,21 @@ libraries:
         Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.
       type: boolean
       default: false
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: db.system
+          type: STRING
+        - name: http.request.method
+          type: STRING
+        - name: server.address
+          type: STRING
+        - name: server.port
+          type: LONG
+        - name: url.full
+          type: STRING
   - name: elasticsearch-transport-5.0
     description: |
       This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.

instrumentation-docs/collect.sh

@@ -1,17 +1,11 @@
 #!/usr/bin/env bash
 
 # Runs selected Gradle test tasks to regenerate *.telemetry output for
-# individual OpenTelemetry Java agent instrumentations.
+# individual OpenTelemetry Java agent instrumentations. Some instrumentation test suites don't run
+# on Apple Silicon, so we use colima to run them in an x86_64 container.
 
 set -euo pipefail
 
-# Oracle UCP won't run on Apple Silicon, so we need to use colima to run as x86_64
-if [[ "$(uname -m)" == "arm64" || "$(uname -m)" == "aarch64" ]]; then
-  colima start --arch x86_64 --memory 4
-  export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock
-  export DOCKER_HOST="unix://${HOME}/.colima/docker.sock"
-fi
-
 readonly INSTRUMENTATIONS=(
   # <module path (colon-separated)> : <javaagent|library> : [ gradle-task-suffix ]
   "activej-http-6.0:javaagent:test"
@@ -66,12 +60,15 @@ readonly INSTRUMENTATIONS=(
   "hikaricp-3.0:javaagent:testStableSemconv"
   "tomcat:tomcat-jdbc:javaagent:test"
   "tomcat:tomcat-jdbc:javaagent:testStableSemconv"
-  "oracle-ucp-11.2:javaagent:test"
-  "oracle-ucp-11.2:javaagent:testStableSemconv"
   "oshi:javaagent:test"
   "oshi:javaagent:testExperimental"
   "vibur-dbcp-11.0:javaagent:test"
   "vibur-dbcp-11.0:javaagent:testStableSemconv"
+  "elasticsearch:elasticsearch-api-client-7.16:javaagent:test"
+  "elasticsearch:elasticsearch-api-client-7.16:javaagent:testStableSemconv"
+  "elasticsearch:elasticsearch-rest-5.0:javaagent:test"
+  "elasticsearch:elasticsearch-rest-6.4:javaagent:test"
+  "elasticsearch:elasticsearch-rest-7.0:javaagent:test"
   "elasticsearch:elasticsearch-transport-5.0:javaagent:test"
   "elasticsearch:elasticsearch-transport-5.0:javaagent:testStableSemconv"
   "elasticsearch:elasticsearch-transport-5.0:javaagent:testExperimental"
@@ -89,6 +86,11 @@ readonly INSTRUMENTATIONS=(
   "elasticsearch:elasticsearch-transport-6.0:javaagent:elasticsearch7TestExperimental"
 )
 
+readonly COLIMA_INSTRUMENTATIONS=(
+  "oracle-ucp-11.2:javaagent:test"
+  "oracle-ucp-11.2:javaagent:testStableSemconv"
+)
+
 readonly TELEMETRY_DIR_NAME=".telemetry"
 
 # Splits a single descriptor into its three logical parts.
@@ -159,39 +161,88 @@ build_gradle_task() {
   echo "$task"
 }
 
+# Processes a list of descriptors and returns an array of Gradle tasks
+# Args: array of descriptors
+# Echoes the Gradle tasks, one per line
+process_descriptors() {
+  local descriptors=("$@")
+  local -a tasks=()
+
+  for descriptor in "${descriptors[@]}"; do
+    # Parse the descriptor into its components
+    if ! read -r module_path task_type task_suffix \
+          < <(parse_descriptor "$descriptor"); then
+      continue   # skip any badly formed descriptors
+    fi
+
+    # Make sure we're starting fresh for this instrumentation
+    delete_existing_telemetry "$module_path"
+
+    # Build the Gradle task string and add to array
+    tasks+=( "$(build_gradle_task "$module_path" "$task_type" "$task_suffix")" )
+  done
+
+  # Echo tasks, one per line
+  for t in "${tasks[@]}"; do
+    echo "$t"
+  done
+}
+
+run_gradle_tasks() {
+  local -a tasks=("$@")
+
+  if [[ ${#tasks[@]} -eq 0 ]]; then
+    echo "No tasks to run"
+    return 0
+  fi
+
+  echo
+  echo "Running Gradle tasks:"
+  printf '    %s\n' "${tasks[@]}"
+  echo
+
+  ./gradlew "${tasks[@]}" \
+    -PcollectMetadata=true \
+    --rerun-tasks --continue
+}
+
 # Cleans any stray .telemetry directories left in the repo.
 find_and_remove_all_telemetry() {
   echo "Removing stray .telemetry directories..."
   find . -type d -name "$TELEMETRY_DIR_NAME" -exec rm -rf {} +
 }
 
-# Main
-declare -a gradle_tasks=()
 
-for descriptor in "${INSTRUMENTATIONS[@]}"; do
-  # Parse the descriptor into its components
-  if ! read -r module_path task_type task_suffix \
-        < <(parse_descriptor "$descriptor"); then
-    continue   # skip any badly formed descriptors
-  fi
+# Main execution
+main() {
+  colima stop
+
+  # Process regular instrumentations
+  echo "Processing standard instrumentations..."
+  gradle_tasks=()
+  while IFS= read -r line; do
+    gradle_tasks+=("$line")
+  done < <(process_descriptors "${INSTRUMENTATIONS[@]}")
+  run_gradle_tasks "${gradle_tasks[@]}"
 
-  # Make sure we’re starting fresh for this instrumentation
-  delete_existing_telemetry "$module_path"
+  # Setup colima for Oracle UCP tests if needed
+  setup_colima
 
-  # Build the Gradle task string and queue it
-  gradle_tasks+=( "$(build_gradle_task "$module_path" "$task_type" "$task_suffix")" )
-done
+  # Process colima-specific instrumentations
+  echo "Processing colima instrumentations..."
+  gradle_tasks=()
+  while IFS= read -r line; do
+    gradle_tasks+=("$line")
+  done < <(process_descriptors "${COLIMA_INSTRUMENTATIONS[@]}")
+  run_gradle_tasks "${gradle_tasks[@]}"
 
-echo
-echo "Running Gradle tasks:"
-printf '    %s\n' "${gradle_tasks[@]}"
-echo
+  colima stop
 
-./gradlew "${gradle_tasks[@]}" \
-  -PcollectMetadata=true \
-  --rerun-tasks --continue
+  # uncomment the next line to remove all .telemetry directories
+  #find_and_remove_all_telemetry
 
-# uncomment the next line to remove all .telemetry directories
-#find_and_remove_all_telemetry
+  echo "Telemetry file regeneration complete."
+}
 
-echo "Telemetry file regeneration complete."
+# Run main function
+main "$@"

instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/build.gradle.kts

@@ -77,10 +77,14 @@ tasks {
   withType<Test>().configureEach {
     jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true")
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+    systemProperty("collectSpans", true)
   }
 
   val testStableSemconv by registering(Test::class) {
     jvmArgs("-Dotel.semconv-stability.opt-in=database")
+    systemProperty("metaDataConfig", "otel.semconv-stability.opt-in=database")
   }
 
   check {

instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml

@@ -0,0 +1,2 @@
+description: This instrumentation provides client spans for Elasticsearch API client requests for
+  version 7 of the client. Versions 8.10 and later have native support for OpenTelemetry.

instrumentation/elasticsearch/elasticsearch-rest-5.0/javaagent/build.gradle.kts

@@ -39,5 +39,8 @@ tasks {
   withType<Test>().configureEach {
     systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+    systemProperty("collectSpans", true)
   }
 }

instrumentation/elasticsearch/elasticsearch-rest-6.4/javaagent/build.gradle.kts

@@ -38,5 +38,8 @@ dependencies {
 tasks {
   test {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+    systemProperty("collectSpans", true)
   }
 }

instrumentation/elasticsearch/elasticsearch-rest-7.0/javaagent/build.gradle.kts

@@ -41,5 +41,8 @@ dependencies {
 tasks {
   test {
     usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+    systemProperty("collectSpans", true)
   }
 }