Insert OpenTelemetry phase before Setup (#13239)

Author: rolaca11

instrumentation/ktor/ktor-2-common/library/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/common/internal/KtorServerTelemetryUtil.kt

@@ -33,26 +33,32 @@ object KtorServerTelemetryUtil {
     val tracer = KtorServerTracer(instrumenter)
     val startPhase = PipelinePhase("OpenTelemetry")
 
-    application.insertPhaseBefore(ApplicationCallPipeline.Monitoring, startPhase)
+    application.insertPhaseBefore(ApplicationCallPipeline.Setup, startPhase)
     application.intercept(startPhase) {
       val context = tracer.start(call)
 
       if (context != null) {
         call.attributes.put(contextKey, context)
         withContext(context.asContextElement()) {
-          try {
-            proceed()
-          } catch (err: Throwable) {
-            // Stash error for reporting later since need ktor to finish setting up the response
-            call.attributes.put(errorKey, err)
-            throw err
-          }
+          proceed()
         }
       } else {
         proceed()
       }
     }
 
+    val errorPhase = PipelinePhase("OpenTelemetryError")
+    application.insertPhaseBefore(ApplicationCallPipeline.Monitoring, errorPhase)
+    application.intercept(errorPhase) {
+      try {
+        proceed()
+      } catch (err: Throwable) {
+        // Stash error for reporting later since need ktor to finish setting up the response
+        call.attributes.put(errorKey, err)
+        throw err
+      }
+    }
+
     val postSendPhase = PipelinePhase("OpenTelemetryPostSend")
     application.sendPipeline.insertPhaseAfter(ApplicationSendPipeline.After, postSendPhase)
     application.sendPipeline.intercept(postSendPhase) {

instrumentation/ktor/ktor-3.0/library/README.md

@@ -32,7 +32,8 @@ implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-3.0:OPENTELE
 
 ## Initializing server instrumentation
 
-Initialize instrumentation by installing the `KtorServerTelemetry` feature.
+Initialize instrumentation by installing the `KtorServerTelemetry` feature. Make sure that no other
+logging plugin is installed before this.
 You must set the `OpenTelemetry` to use with the feature.
 
 ```kotlin

instrumentation/ktor/ktor-3.0/library/src/test/kotlin/io/opentelemetry/instrumentation/ktor/v3_0/KtorHttpServerTest.kt

@@ -5,9 +5,13 @@
 
 package io.opentelemetry.instrumentation.ktor.v3_0
 
+import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.*
+import io.ktor.server.application.hooks.CallFailed
+import io.ktor.server.response.respondText
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension
 import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension
+import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint
 import org.junit.jupiter.api.extension.RegisterExtension
 
 class KtorHttpServerTest : AbstractKtorHttpServerTest() {
@@ -27,6 +31,12 @@ class KtorHttpServerTest : AbstractKtorHttpServerTest() {
         capturedRequestHeaders(TEST_REQUEST_HEADER)
         capturedResponseHeaders(TEST_RESPONSE_HEADER)
       }
+
+      install(createRouteScopedPlugin("Failure handler, that can mask exceptions if exception handling is in the wrong phase", ServerEndpoint.EXCEPTION.path, {}) {
+        on(CallFailed) { call, cause ->
+          call.respondText("failure: ${cause.message}", status = HttpStatusCode.InternalServerError)
+        }
+      })
     }
   }
 }