Add comments

Author: marychatte

opentelemetry/client/src/main/kotlin/opentelemetry/ktor/example/Requests.kt

@@ -7,24 +7,33 @@ import io.ktor.websocket.*
 
 
 suspend fun doRequests(client: HttpClient) {
+    // For this request you can see `CUSTOM` method instead of default `HTTP` in the Jaeger UI
     client.request("/known-methods") {
         method = CUSTOM_METHOD
     }
 
+    // For this request you can't see `CUSTOM_NOT_KNOWN` method, you can see default `HTTP` in the Jaeger UI
     client.request("/known-methods") {
         method = CUSTOM_METHOD_NOT_KNOWN
     }
 
+    // You can see tags `http.request.header.accept` and `http.response.header.content_type` for all requests
+    // in the Jaeger UI and also `http.response.header.custom_header` for this request
     client.get("/captured-headers")
 
+    // For this request you can see tag `error=true` and `Error` icon only for server trace in the Jaeger UI
     client.get("/span-status-extractor")
 
+    // For this request you can see tag `span.kind=producer` only for server trace in the Jaeger UI
     client.post("/span-kind-extractor")
 
+    // You can see attribute `start-time` and `end-time` in the Jaeger UI for all requests
     client.get("/attribute-extractor")
 
+    // For this request you can see several spans and events only for server trace in the Jaeger UI
     client.get("/opentelemetry/tracer")
 
+    // For this request you can see several events only for server trace in the Jaeger UI
     client.ws("/opentelemetry/websocket") {
         send(Frame.Text("Hello, world!"))
         repeat(10) {

opentelemetry/client/src/main/kotlin/opentelemetry/ktor/example/plugins/opentelemetry/setupClientTelemetry.kt

@@ -9,7 +9,6 @@ import opentelemetry.ktor.example.CUSTOM_METHOD
 import opentelemetry.ktor.example.getOpenTelemetry
 import opentelemetry.ktor.example.plugins.opentelemetry.extractions.*
 
-
 /**
  * Install OpenTelemetry on the client.
  * You can see usages of new extension functions for [KtorClientTracing].
@@ -22,7 +21,7 @@ fun HttpClientConfig<CIOEngineConfig>.setupClientTelemetry() {
         emitExperimentalHttpClientMetrics()
 
         knownMethods(HttpMethod.DefaultMethods + CUSTOM_METHOD)
-        capturedRequestHeaders(HttpHeaders.UserAgent)
+        capturedRequestHeaders(HttpHeaders.Accept)
         capturedResponseHeaders(HttpHeaders.ContentType, CUSTOM_HEADER)
 
         attributeExtractor {

opentelemetry/server/src/main/kotlin/opentelemetry/ktor/example/plugins/opentelemetry/setupServerTelemetry.kt

@@ -29,10 +29,8 @@ fun Application.setupServerTelemetry(): OpenTelemetry {
         capturedResponseHeaders(HttpHeaders.ContentType, CUSTOM_HEADER)
 
         spanStatusExtractor {
-            val success = response?.status()?.let {
-                it.isSuccess() || it == HttpStatusCode.SwitchingProtocols
-            } ?: false
-            if (!success || error != null) {
+            val path = response?.call?.request?.path() ?: ""
+            if (path.contains("/span-status-extractor") || error != null) {
                 spanStatusBuilder.setStatus(StatusCode.ERROR)
             }
         }

opentelemetry/server/src/main/kotlin/opentelemetry/ktor/example/plugins/routing/Routing.kt

@@ -1,18 +1,17 @@
 package opentelemetry.ktor.example.plugins.routing
 
-import opentelemetry.ktor.example.CUSTOM_HEADER
-import opentelemetry.ktor.example.CUSTOM_METHOD
-import opentelemetry.ktor.example.CUSTOM_METHOD_NOT_KNOWN
-import io.ktor.http.*
 import io.ktor.server.application.*
 import io.ktor.server.response.*
 import io.ktor.server.routing.*
 import io.ktor.server.websocket.*
 import io.ktor.websocket.*
 import io.opentelemetry.api.trace.Span
 import kotlinx.coroutines.delay
-import opentelemetry.ktor.example.plugins.opentelemetry.setupServerTelemetry
+import opentelemetry.ktor.example.CUSTOM_HEADER
+import opentelemetry.ktor.example.CUSTOM_METHOD
+import opentelemetry.ktor.example.CUSTOM_METHOD_NOT_KNOWN
 import opentelemetry.ktor.example.plugins.opentelemetry.serviceName
+import opentelemetry.ktor.example.plugins.opentelemetry.setupServerTelemetry
 
 fun Application.configureRouting() {
     install(WebSockets)
@@ -47,15 +46,12 @@ fun Application.configureRouting() {
             call.response.headers.append(CUSTOM_HEADER, "it's a custom value")
             call.respondText(
                 "You can see tags `http.request.header.user_agent` and `http.response.header.content_type` for " +
-                        "all request in the Jaeger UI and also `http.response.header.custom_header` for this request"
+                        "all requests in the Jaeger UI and also `http.response.header.custom_header` for this request"
             )
         }
 
         get("/span-status-extractor") {
-            call.respond(
-                HttpStatusCode.NotFound,
-                "For this request you can see tag `error=true` and `Error` icon in the Jaeger UI"
-            )
+            call.respond("For this request you can see tag `error=true` and `Error` icon in the Jaeger UI")
         }
 
         post("/span-kind-extractor") {
@@ -75,7 +71,7 @@ fun Application.configureRouting() {
                 try {
                     span.makeCurrent().use { _ ->
                         Span.current().addEvent("Starting the work")
-                        call.respondText { "For this request you can see several spans in the Jaeger UI" }
+                        call.respondText { "For this request you can see several spans and events in the Jaeger UI" }
                         Span.current().addEvent("Finished working")
                     }
                 } finally {