Kotlin coroutines and ktor metadata (open-telemetry#15295)

Co-authored-by: Lauri Tulmin <[email protected]>

Author: jaydeluca

docs/instrumentation-list.yaml

@@ -150,6 +150,9 @@ readonly INSTRUMENTATIONS=(
   "jsp-2.3:javaagent:testExperimental"
   "kafka:kafka-clients:kafka-clients-2.6:library:test"
   "kafka:kafka-connect-2.6:testing:test"
+  "ktor:ktor-1.0:library:test"
+  "ktor:ktor-2.0:library:test"
+  "ktor:ktor-3.0:library:test"
   "kubernetes-client-7.0:javaagent:test"
   "kubernetes-client-7.0:javaagent:testExperimental"
   "nats:nats-2.17:javaagent:test"

instrumentation-docs/instrumentations.sh

@@ -0,0 +1,7 @@
+description: >
+  This instrumentation enables context propagation for Kotlin coroutines and adds support for
+  @WithSpan annotations on Kotlin suspend functions.
+display_name: Kotlin Coroutines
+features:
+  - CONTEXT_PROPAGATION
+library_link: https://github.com/Kotlin/kotlinx.coroutines

instrumentation/kotlinx-coroutines/kotlinx-coroutines-1.0/metadata.yaml

@@ -0,0 +1,3 @@
+description: This instrumentation adds support for @WithSpan annotations on methods that return Kotlin Flow.
+display_name: Kotlin Coroutines Flow
+library_link: https://github.com/Kotlin/kotlinx.coroutines

instrumentation/kotlinx-coroutines/kotlinx-coroutines-flow-1.3/metadata.yaml

@@ -31,6 +31,6 @@ kotlin {
   }
 }
 
-tasks.withType<Test>().configureEach {
-  jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true")
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
 }

instrumentation/ktor/ktor-1.0/library/build.gradle.kts

@@ -0,0 +1,7 @@
+description: This standalone instrumentation enables HTTP server spans and HTTP server metrics for the Ktor server.
+semantic_conventions:
+  - HTTP_SERVER_SPANS
+  - HTTP_SERVER_METRICS
+features:
+  - HTTP_ROUTE
+library_link: https://ktor.io/

instrumentation/ktor/ktor-1.0/metadata.yaml

@@ -59,3 +59,7 @@ kotlin {
     javaParameters = true
   }
 }
+
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}

instrumentation/ktor/ktor-2.0/javaagent/build.gradle.kts

@@ -37,3 +37,7 @@ kotlin {
     languageVersion.set(KotlinVersion.KOTLIN_1_8)
   }
 }
+
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}

instrumentation/ktor/ktor-2.0/library/build.gradle.kts

@@ -0,0 +1,56 @@
+description: >
+  This instrumentation provides HTTP server spans and HTTP server metrics for the Ktor server,
+  and HTTP client spans and HTTP client metrics for the Ktor HTTP client.
+semantic_conventions:
+  - HTTP_SERVER_SPANS
+  - HTTP_SERVER_METRICS
+  - HTTP_CLIENT_SPANS
+  - HTTP_CLIENT_METRICS
+features:
+  - HTTP_ROUTE
+library_link: https://ktor.io/
+configurations:
+  - name: otel.instrumentation.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
+    description: List of HTTP request headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP server telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.server.emit-experimental-telemetry
+    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
+      `http.server.response.size` metrics.
+    type: boolean
+    default: false
+  - name: otel.instrumentation.http.client.capture-request-headers
+    description: List of HTTP request headers to capture in HTTP client telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.http.client.capture-response-headers
+    description: List of HTTP response headers to capture in HTTP client telemetry.
+    type: list
+    default: ""
+  - name: otel.instrumentation.common.peer-service-mapping
+    description: Used to specify a mapping from host names or IP addresses to peer services.
+    type: map
+    default: ""
+  - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    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.http.client.experimental.redact-query-parameters
+    description: Redact sensitive URL parameters. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
+    type: boolean
+    default: true

instrumentation/ktor/ktor-2.0/metadata.yaml

@@ -32,3 +32,7 @@ kotlin {
     languageVersion.set(KotlinVersion.KOTLIN_1_8)
   }
 }
+
+tasks.test {
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}