Add deprecations

open-telemetry · Apr 25, 2024 · 4343545 · 4343545
1 parent 15042d7
commit 4343545
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 67 deletions.
diff --git a/...main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/KtorClientTracingBuilder.kt b/...main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/client/KtorClientTracingBuilder.kt
@@ -34,65 +34,78 @@ class KtorClientTracingBuilder {
     this.openTelemetry = openTelemetry
   }
 
-  fun setCapturedRequestHeaders(vararg headers: String) = setCapturedRequestHeaders(headers.asList())
+  @Deprecated(
+    "Please use method `capturedRequestHeaders`",
+    ReplaceWith("capturedRequestHeaders(headers.asIterable())")
+  )
+  fun setCapturedRequestHeaders(vararg headers: String) = capturedRequestHeaders(headers.asIterable())
 
-  fun setCapturedRequestHeaders(headers: List<String>) {
-    httpAttributesExtractorBuilder.setCapturedRequestHeaders(headers)
-  }
+  @Deprecated(
+    "Please use method `capturedRequestHeaders`",
+    ReplaceWith("capturedRequestHeaders(headers)")
+  )
+  fun setCapturedRequestHeaders(headers: List<String>) = capturedRequestHeaders(headers)
 
-  fun capturedRequestHeaders(vararg headers: String) {
-    capturedRequestHeaders(headers.asIterable())
-  }
+  fun capturedRequestHeaders(vararg headers: String) = capturedRequestHeaders(headers.asIterable())
 
   fun capturedRequestHeaders(headers: Iterable<String>) {
-    setCapturedRequestHeaders(headers.toList())
+    httpAttributesExtractorBuilder.setCapturedRequestHeaders(headers.toList())
   }
 
-  fun setCapturedResponseHeaders(vararg headers: String) = setCapturedResponseHeaders(headers.asList())
+  @Deprecated(
+    "Please use method `capturedResponseHeaders`",
+    ReplaceWith("capturedResponseHeaders(headers.asIterable())")
+  )
+  fun setCapturedResponseHeaders(vararg headers: String) = capturedResponseHeaders(headers.asIterable())
 
-  fun setCapturedResponseHeaders(headers: List<String>) {
-    httpAttributesExtractorBuilder.setCapturedResponseHeaders(headers)
-  }
+  @Deprecated(
+    "Please use method `capturedResponseHeaders`",
+    ReplaceWith("capturedResponseHeaders(headers)")
+  )
+  fun setCapturedResponseHeaders(headers: List<String>) = capturedResponseHeaders(headers)
 
-  fun capturedResponseHeaders(vararg headers: String) {
-    capturedResponseHeaders(headers.asIterable())
-  }
+  fun capturedResponseHeaders(vararg headers: String) = capturedResponseHeaders(headers.asIterable())
 
   fun capturedResponseHeaders(headers: Iterable<String>) {
-    setCapturedResponseHeaders(headers.toList())
+    httpAttributesExtractorBuilder.setCapturedResponseHeaders(headers.toList())
   }
 
-  fun setKnownMethods(knownMethods: Set<String>) {
-    httpAttributesExtractorBuilder.setKnownMethods(knownMethods)
-    httpSpanNameExtractorBuilder.setKnownMethods(knownMethods)
-  }
-
-  fun knownMethods(vararg methods: String) {
-    setKnownMethods(methods.toSet())
-  }
+  @Deprecated(
+    "Please use method `knownMethods`",
+    ReplaceWith("knownMethods(knownMethods)")
+  )
+  fun setKnownMethods(knownMethods: Set<String>) = knownMethods(knownMethods)
 
-  fun knownMethods(methods: Iterable<String>) {
-    setKnownMethods(methods.toSet())
-  }
+  fun knownMethods(vararg methods: String) = knownMethods(methods.asIterable())
 
-  fun knownMethods(vararg methods: HttpMethod) {
-    knownMethods(methods.asIterable())
-  }
+  fun knownMethods(vararg methods: HttpMethod) = knownMethods(methods.asIterable())
 
   @JvmName("knownMethodsJvm")
-  fun knownMethods(methods: Iterable<HttpMethod>) {
-    setKnownMethods(methods.map { it.value }.toSet())
+  fun knownMethods(methods: Iterable<HttpMethod>) = knownMethods(methods.map { it.value })
+
+  fun knownMethods(methods: Iterable<String>) {
+    methods.toSet().apply {
+      httpAttributesExtractorBuilder.setKnownMethods(this)
+      httpSpanNameExtractorBuilder.setKnownMethods(this)
+    }
   }
 
+  @Deprecated("Please use method `attributeExtractor`")
   fun addAttributesExtractors(vararg extractors: AttributesExtractor<in HttpRequestData, in HttpResponse>) = addAttributesExtractors(extractors.asList())
 
+  @Deprecated("Please use method `attributeExtractor`")
   fun addAttributesExtractors(extractors: Iterable<AttributesExtractor<in HttpRequestData, in HttpResponse>>) {
-    additionalExtractors += extractors
+    extractors.forEach {
+      attributeExtractor {
+        onStart { it.onStart(attributes, parentContext, request) }
+        onEnd { it.onEnd(attributes, parentContext, request, response, error) }
+      }
+    }
   }
 
   fun attributeExtractor(extractorBuilder: ExtractorBuilder.() -> Unit = {}) {
     val builder = ExtractorBuilder().apply(extractorBuilder).build()
-    addAttributesExtractors(
+    additionalExtractors.add(
       object : AttributesExtractor<HttpRequestData, HttpResponse> {
         override fun onStart(attributes: AttributesBuilder, parentContext: Context, request: HttpRequestData) {
           builder.onStart(OnStartData(attributes, parentContext, request))
@@ -143,12 +156,15 @@ class KtorClientTracingBuilder {
    *
    * @param emitExperimentalHttpClientMetrics `true` if the experimental HTTP client metrics are to be emitted.
    */
+  @Deprecated("Please use method `emitExperimentalHttpClientMetrics`")
   fun setEmitExperimentalHttpClientMetrics(emitExperimentalHttpClientMetrics: Boolean) {
-    this.emitExperimentalHttpClientMetrics = emitExperimentalHttpClientMetrics
+    if (emitExperimentalHttpClientMetrics) {
+      emitExperimentalHttpClientMetrics()
+    }
   }
 
   fun emitExperimentalHttpClientMetrics() {
-    setEmitExperimentalHttpClientMetrics(true)
+    emitExperimentalHttpClientMetrics = true
   }
 
   internal fun build(): KtorClientTracing {

diff --git a/...ry/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/server/KtorServerTracing.kt b/...ry/src/main/kotlin/io/opentelemetry/instrumentation/ktor/v2_0/server/KtorServerTracing.kt
@@ -57,6 +57,7 @@ class KtorServerTracing private constructor(
       this.openTelemetry = openTelemetry
     }
 
+    @Deprecated("Please use method `spanStatusExtractor`")
     fun setStatusExtractor(
       extractor: (SpanStatusExtractor<ApplicationRequest, ApplicationResponse>) -> SpanStatusExtractor<in ApplicationRequest, in ApplicationResponse>
     ) {
@@ -83,6 +84,7 @@ class KtorServerTracing private constructor(
       val error: Throwable?
     )
 
+    @Deprecated("Please use method `spanKindExtractor`")
     fun setSpanKindExtractor(extractor: (SpanKindExtractor<ApplicationRequest>) -> SpanKindExtractor<ApplicationRequest>) {
       spanKindExtractor { prevSpanKindExtractor ->
         extractor(prevSpanKindExtractor).extract(this)
@@ -97,6 +99,7 @@ class KtorServerTracing private constructor(
       }
     }
 
+    @Deprecated("Please use method `attributeExtractor`")
     fun addAttributeExtractor(extractor: AttributesExtractor<in ApplicationRequest, in ApplicationResponse>) {
       attributeExtractor {
         onStart {
@@ -156,51 +159,49 @@ class KtorServerTracing private constructor(
       val error: Throwable?
     )
 
-    fun setCapturedRequestHeaders(requestHeaders: List<String>) {
-      httpAttributesExtractorBuilder.setCapturedRequestHeaders(requestHeaders)
-    }
+    @Deprecated(
+      "Please use method `capturedRequestHeaders`",
+      ReplaceWith("capturedRequestHeaders(headers)")
+    )
+    fun setCapturedRequestHeaders(headers: List<String>) = capturedRequestHeaders(headers)
+
+    fun capturedRequestHeaders(vararg headers: String) = capturedRequestHeaders(headers.asIterable())
 
     fun capturedRequestHeaders(headers: Iterable<String>) {
-      setCapturedRequestHeaders(headers.toList())
+      httpAttributesExtractorBuilder.setCapturedRequestHeaders(headers.toList())
     }
 
-    fun capturedRequestHeaders(vararg headers: String) {
-      capturedRequestHeaders(headers.asIterable())
-    }
+    @Deprecated(
+      "Please use method `capturedResponseHeaders`",
+      ReplaceWith("capturedResponseHeaders(headers)")
+    )
+    fun setCapturedResponseHeaders(headers: List<String>) = capturedResponseHeaders(headers)
 
-    fun setCapturedResponseHeaders(responseHeaders: List<String>) {
-      httpAttributesExtractorBuilder.setCapturedResponseHeaders(responseHeaders)
-    }
+    fun capturedResponseHeaders(vararg headers: String) = capturedResponseHeaders(headers.asIterable())
 
     fun capturedResponseHeaders(headers: Iterable<String>) {
-      setCapturedResponseHeaders(headers.toList())
-    }
-
-    fun capturedResponseHeaders(vararg headers: String) {
-      capturedResponseHeaders(headers.asIterable())
+      httpAttributesExtractorBuilder.setCapturedResponseHeaders(headers.toList())
     }
 
-    fun setKnownMethods(knownMethods: Set<String>) {
-      httpAttributesExtractorBuilder.setKnownMethods(knownMethods)
-      httpSpanNameExtractorBuilder.setKnownMethods(knownMethods)
-      httpServerRouteBuilder.setKnownMethods(knownMethods)
-    }
+    @Deprecated(
+      "Please use method `knownMethods`",
+      ReplaceWith("knownMethods(knownMethods)")
+    )
+    fun setKnownMethods(knownMethods: Set<String>) = knownMethods(knownMethods)
 
-    fun knownMethods(vararg methods: String) {
-      setKnownMethods(methods.toSet())
-    }
+    fun knownMethods(vararg methods: String) = knownMethods(methods.asIterable())
 
-    fun knownMethods(methods: Iterable<String>) {
-      setKnownMethods(methods.toSet())
-    }
+    fun knownMethods(vararg methods: HttpMethod) = knownMethods(methods.asIterable())
 
     @JvmName("knownMethodsJvm")
-    fun knownMethods(methods: Iterable<HttpMethod>) {
-      knownMethods(methods.map { it.value })
-    }
+    fun knownMethods(methods: Iterable<HttpMethod>) = knownMethods(methods.map { it.value })
 
-    fun knownMethods(vararg methods: HttpMethod) {
-      knownMethods(methods.map { it.value })
+    fun knownMethods(methods: Iterable<String>) {
+      methods.toSet().apply {
+        httpAttributesExtractorBuilder.setKnownMethods(this)
+        httpSpanNameExtractorBuilder.setKnownMethods(this)
+        httpServerRouteBuilder.setKnownMethods(this)
+      }
     }
 
     internal fun isOpenTelemetryInitialized(): Boolean = this::openTelemetry.isInitialized