|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package io.opentelemetry.instrumentation.ktor.client |
| 7 | + |
| 8 | +import io.ktor.client.request.* |
| 9 | +import io.ktor.client.statement.* |
| 10 | +import io.ktor.http.* |
| 11 | +import io.opentelemetry.api.OpenTelemetry |
| 12 | +import io.opentelemetry.api.common.AttributesBuilder |
| 13 | +import io.opentelemetry.context.Context |
| 14 | +import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpClientInstrumenterBuilder |
| 15 | +import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor |
| 16 | +import io.opentelemetry.instrumentation.ktor.internal.KtorBuilderUtil |
| 17 | + |
| 18 | +abstract class AbstractKtorClientTracingBuilder( |
| 19 | + private val instrumentationName: String |
| 20 | +) { |
| 21 | + companion object { |
| 22 | + init { |
| 23 | + KtorBuilderUtil.clientBuilderExtractor = { it.clientBuilder } |
| 24 | + } |
| 25 | + } |
| 26 | + |
| 27 | + internal lateinit var openTelemetry: OpenTelemetry |
| 28 | + protected lateinit var clientBuilder: DefaultHttpClientInstrumenterBuilder<HttpRequestData, HttpResponse> |
| 29 | + |
| 30 | + fun setOpenTelemetry(openTelemetry: OpenTelemetry) { |
| 31 | + this.openTelemetry = openTelemetry |
| 32 | + this.clientBuilder = DefaultHttpClientInstrumenterBuilder.create( |
| 33 | + instrumentationName, |
| 34 | + openTelemetry, |
| 35 | + KtorHttpClientAttributesGetter |
| 36 | + ) |
| 37 | + } |
| 38 | + |
| 39 | + protected fun getOpenTelemetry(): OpenTelemetry { |
| 40 | + return openTelemetry |
| 41 | + } |
| 42 | + |
| 43 | + @Deprecated( |
| 44 | + "Please use method `capturedRequestHeaders`", |
| 45 | + ReplaceWith("capturedRequestHeaders(headers.asIterable())") |
| 46 | + ) |
| 47 | + fun setCapturedRequestHeaders(vararg headers: String) = capturedRequestHeaders(headers.asIterable()) |
| 48 | + |
| 49 | + @Deprecated( |
| 50 | + "Please use method `capturedRequestHeaders`", |
| 51 | + ReplaceWith("capturedRequestHeaders(headers)") |
| 52 | + ) |
| 53 | + fun setCapturedRequestHeaders(headers: List<String>) = capturedRequestHeaders(headers) |
| 54 | + |
| 55 | + fun capturedRequestHeaders(vararg headers: String) = capturedRequestHeaders(headers.asIterable()) |
| 56 | + |
| 57 | + fun capturedRequestHeaders(headers: Iterable<String>) { |
| 58 | + clientBuilder.setCapturedRequestHeaders(headers.toList()) |
| 59 | + } |
| 60 | + |
| 61 | + @Deprecated( |
| 62 | + "Please use method `capturedResponseHeaders`", |
| 63 | + ReplaceWith("capturedResponseHeaders(headers.asIterable())") |
| 64 | + ) |
| 65 | + fun setCapturedResponseHeaders(vararg headers: String) = capturedResponseHeaders(headers.asIterable()) |
| 66 | + |
| 67 | + @Deprecated( |
| 68 | + "Please use method `capturedResponseHeaders`", |
| 69 | + ReplaceWith("capturedResponseHeaders(headers)") |
| 70 | + ) |
| 71 | + fun setCapturedResponseHeaders(headers: List<String>) = capturedResponseHeaders(headers) |
| 72 | + |
| 73 | + fun capturedResponseHeaders(vararg headers: String) = capturedResponseHeaders(headers.asIterable()) |
| 74 | + |
| 75 | + fun capturedResponseHeaders(headers: Iterable<String>) { |
| 76 | + clientBuilder.setCapturedResponseHeaders(headers.toList()) |
| 77 | + } |
| 78 | + |
| 79 | + @Deprecated( |
| 80 | + "Please use method `knownMethods`", |
| 81 | + ReplaceWith("knownMethods(knownMethods)") |
| 82 | + ) |
| 83 | + fun setKnownMethods(knownMethods: Set<String>) = knownMethods(knownMethods) |
| 84 | + |
| 85 | + fun knownMethods(vararg methods: String) = knownMethods(methods.asIterable()) |
| 86 | + |
| 87 | + fun knownMethods(vararg methods: HttpMethod) = knownMethods(methods.asIterable()) |
| 88 | + |
| 89 | + @JvmName("knownMethodsJvm") |
| 90 | + fun knownMethods(methods: Iterable<HttpMethod>) = knownMethods(methods.map { it.value }) |
| 91 | + |
| 92 | + fun knownMethods(methods: Iterable<String>) { |
| 93 | + clientBuilder.setKnownMethods(methods.toSet()) |
| 94 | + } |
| 95 | + |
| 96 | + @Deprecated("Please use method `attributeExtractor`") |
| 97 | + fun addAttributesExtractors(vararg extractors: AttributesExtractor<in HttpRequestData, in HttpResponse>) = addAttributesExtractors(extractors.asList()) |
| 98 | + |
| 99 | + @Deprecated("Please use method `attributeExtractor`") |
| 100 | + fun addAttributesExtractors(extractors: Iterable<AttributesExtractor<in HttpRequestData, in HttpResponse>>) { |
| 101 | + extractors.forEach { |
| 102 | + attributeExtractor { |
| 103 | + onStart { it.onStart(attributes, parentContext, request) } |
| 104 | + onEnd { it.onEnd(attributes, parentContext, request, response, error) } |
| 105 | + } |
| 106 | + } |
| 107 | + } |
| 108 | + |
| 109 | + fun attributeExtractor(extractorBuilder: ExtractorBuilder.() -> Unit = {}) { |
| 110 | + val builder = ExtractorBuilder().apply(extractorBuilder).build() |
| 111 | + this.clientBuilder.addAttributeExtractor( |
| 112 | + object : AttributesExtractor<HttpRequestData, HttpResponse> { |
| 113 | + override fun onStart(attributes: AttributesBuilder, parentContext: Context, request: HttpRequestData) { |
| 114 | + builder.onStart(OnStartData(attributes, parentContext, request)) |
| 115 | + } |
| 116 | + |
| 117 | + override fun onEnd(attributes: AttributesBuilder, context: Context, request: HttpRequestData, response: HttpResponse?, error: Throwable?) { |
| 118 | + builder.onEnd(OnEndData(attributes, context, request, response, error)) |
| 119 | + } |
| 120 | + } |
| 121 | + ) |
| 122 | + } |
| 123 | + |
| 124 | + class ExtractorBuilder { |
| 125 | + private var onStart: OnStartData.() -> Unit = {} |
| 126 | + private var onEnd: OnEndData.() -> Unit = {} |
| 127 | + |
| 128 | + fun onStart(block: OnStartData.() -> Unit) { |
| 129 | + onStart = block |
| 130 | + } |
| 131 | + |
| 132 | + fun onEnd(block: OnEndData.() -> Unit) { |
| 133 | + onEnd = block |
| 134 | + } |
| 135 | + |
| 136 | + internal fun build(): Extractor { |
| 137 | + return Extractor(onStart, onEnd) |
| 138 | + } |
| 139 | + } |
| 140 | + |
| 141 | + internal class Extractor(val onStart: OnStartData.() -> Unit, val onEnd: OnEndData.() -> Unit) |
| 142 | + |
| 143 | + data class OnStartData( |
| 144 | + val attributes: AttributesBuilder, |
| 145 | + val parentContext: Context, |
| 146 | + val request: HttpRequestData |
| 147 | + ) |
| 148 | + |
| 149 | + data class OnEndData( |
| 150 | + val attributes: AttributesBuilder, |
| 151 | + val parentContext: Context, |
| 152 | + val request: HttpRequestData, |
| 153 | + val response: HttpResponse?, |
| 154 | + val error: Throwable? |
| 155 | + ) |
| 156 | + |
| 157 | + /** |
| 158 | + * Configures the instrumentation to emit experimental HTTP client metrics. |
| 159 | + * |
| 160 | + * @param emitExperimentalHttpClientMetrics `true` if the experimental HTTP client metrics are to be emitted. |
| 161 | + */ |
| 162 | + @Deprecated("Please use method `emitExperimentalHttpClientMetrics`") |
| 163 | + fun setEmitExperimentalHttpClientMetrics(emitExperimentalHttpClientMetrics: Boolean) { |
| 164 | + if (emitExperimentalHttpClientMetrics) { |
| 165 | + emitExperimentalHttpClientMetrics() |
| 166 | + } |
| 167 | + } |
| 168 | + |
| 169 | + fun emitExperimentalHttpClientMetrics() { |
| 170 | + clientBuilder.setEmitExperimentalHttpClientMetrics(true) |
| 171 | + } |
| 172 | +} |
0 commit comments