-
Notifications
You must be signed in to change notification settings - Fork 826
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make spanKindExtractor configurable in Ktor instrumentations #8255
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
...test/kotlin/io/opentelemetry/instrumentation/ktor/v1_0/KtorServerSpanKindExtractorTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.ktor.v1_0 | ||
|
|
||
| import io.ktor.application.* | ||
| import io.ktor.http.* | ||
| import io.ktor.request.* | ||
| import io.ktor.response.* | ||
| import io.ktor.routing.* | ||
| import io.ktor.server.engine.* | ||
| import io.ktor.server.netty.* | ||
| import io.opentelemetry.api.trace.SpanKind | ||
| import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor | ||
| import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension | ||
| import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerUsingTest | ||
| import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension | ||
| import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint | ||
| import io.opentelemetry.testing.internal.armeria.common.AggregatedHttpRequest | ||
| import io.opentelemetry.testing.internal.armeria.common.AggregatedHttpResponse | ||
| import io.opentelemetry.testing.internal.armeria.common.HttpMethod | ||
| import org.assertj.core.api.Assertions.assertThat | ||
| import org.junit.jupiter.api.AfterAll | ||
| import org.junit.jupiter.api.BeforeAll | ||
| import org.junit.jupiter.api.extension.RegisterExtension | ||
| import org.junit.jupiter.params.ParameterizedTest | ||
| import org.junit.jupiter.params.provider.Arguments | ||
| import org.junit.jupiter.params.provider.Arguments.arguments | ||
| import org.junit.jupiter.params.provider.MethodSource | ||
| import java.util.concurrent.TimeUnit | ||
| import java.util.function.Consumer | ||
| import java.util.stream.Stream | ||
|
|
||
| class KtorServerSpanKindExtractorTest : AbstractHttpServerUsingTest<ApplicationEngine>() { | ||
|
|
||
| private val consumerKindEndpoint = ServerEndpoint("consumerKindEndpoint", "from-pubsub/run", 200, "") | ||
| private val serverKindEndpoint = ServerEndpoint("serverKindEndpoint", "from-client/run", 200, "") | ||
|
|
||
| companion object { | ||
| @JvmStatic | ||
| @RegisterExtension | ||
| val testing: InstrumentationExtension = HttpServerInstrumentationExtension.forLibrary() | ||
| } | ||
|
|
||
| @BeforeAll | ||
| fun setupOptions() { | ||
| startServer() | ||
| } | ||
|
|
||
| @AfterAll | ||
| fun cleanup() { | ||
| cleanupServer() | ||
| } | ||
|
|
||
| override fun getContextPath() = "" | ||
|
|
||
| override fun setupServer(): ApplicationEngine { | ||
| return embeddedServer(Netty, port = port) { | ||
| install(KtorServerTracing) { | ||
| setOpenTelemetry(testing.openTelemetry) | ||
| setSpanKindExtractor { | ||
| SpanKindExtractor { req -> | ||
| if (req.uri.startsWith("/from-pubsub/")) { | ||
| SpanKind.CONSUMER | ||
| } else { | ||
| SpanKind.SERVER | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| routing { | ||
| post(consumerKindEndpoint.path) { | ||
| call.respondText(consumerKindEndpoint.body, status = HttpStatusCode.fromValue(consumerKindEndpoint.status)) | ||
| } | ||
|
|
||
| post(serverKindEndpoint.path) { | ||
| call.respondText(serverKindEndpoint.body, status = HttpStatusCode.fromValue(serverKindEndpoint.status)) | ||
| } | ||
| } | ||
| }.start() | ||
| } | ||
|
|
||
| override fun stopServer(server: ApplicationEngine) { | ||
| server.stop(0, 10, TimeUnit.SECONDS) | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("provideArguments") | ||
| fun testSpanKindExtractor(endpoint: ServerEndpoint, expectedKind: SpanKind) { | ||
| val request = AggregatedHttpRequest.of(HttpMethod.valueOf("POST"), resolveAddress(endpoint)) | ||
| val response: AggregatedHttpResponse = client.execute(request).aggregate().join() | ||
| assertThat(response.status().code()).isEqualTo(endpoint.status) | ||
|
|
||
| testing.waitAndAssertTraces( | ||
| Consumer { trace -> | ||
| trace.hasSpansSatisfyingExactly( | ||
| Consumer { span -> | ||
| span.hasKind(expectedKind) | ||
| } | ||
| ) | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| private fun provideArguments(): Stream<Arguments> { | ||
| return Stream.of( | ||
| arguments(consumerKindEndpoint, SpanKind.CONSUMER), | ||
| arguments(serverKindEndpoint, SpanKind.SERVER), | ||
| ) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
...tlin/io/opentelemetry/instrumentation/ktor/v2_0/server/KtorServerSpanKindExtractorTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.ktor.v2_0.server | ||
|
|
||
| import io.ktor.http.* | ||
| import io.ktor.server.application.* | ||
| import io.ktor.server.engine.* | ||
| import io.ktor.server.netty.* | ||
| import io.ktor.server.request.* | ||
| import io.ktor.server.response.* | ||
| import io.ktor.server.routing.* | ||
| import io.opentelemetry.api.trace.SpanKind | ||
| import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor | ||
| import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension | ||
| import io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerUsingTest | ||
| import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension | ||
| import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint | ||
| import io.opentelemetry.testing.internal.armeria.common.AggregatedHttpRequest | ||
| import io.opentelemetry.testing.internal.armeria.common.AggregatedHttpResponse | ||
| import io.opentelemetry.testing.internal.armeria.common.HttpMethod | ||
| import org.assertj.core.api.Assertions.assertThat | ||
| import org.junit.jupiter.api.AfterAll | ||
| import org.junit.jupiter.api.BeforeAll | ||
| import org.junit.jupiter.api.extension.RegisterExtension | ||
| import org.junit.jupiter.params.ParameterizedTest | ||
| import org.junit.jupiter.params.provider.Arguments | ||
| import org.junit.jupiter.params.provider.Arguments.arguments | ||
| import org.junit.jupiter.params.provider.MethodSource | ||
| import java.util.concurrent.TimeUnit | ||
| import java.util.function.Consumer | ||
| import java.util.stream.Stream | ||
|
|
||
| class KtorServerSpanKindExtractorTest : AbstractHttpServerUsingTest<ApplicationEngine>() { | ||
|
|
||
| private val consumerKindEndpoint = ServerEndpoint("consumerKindEndpoint", "from-pubsub/run", 200, "") | ||
| private val serverKindEndpoint = ServerEndpoint("serverKindEndpoint", "from-client/run", 200, "") | ||
|
|
||
| companion object { | ||
| @JvmStatic | ||
| @RegisterExtension | ||
| val testing: InstrumentationExtension = HttpServerInstrumentationExtension.forLibrary() | ||
| } | ||
|
|
||
| @BeforeAll | ||
| fun setupOptions() { | ||
| startServer() | ||
| } | ||
|
|
||
| @AfterAll | ||
| fun cleanup() { | ||
| cleanupServer() | ||
| } | ||
|
|
||
| override fun getContextPath() = "" | ||
|
|
||
| override fun setupServer(): ApplicationEngine { | ||
| return embeddedServer(Netty, port = port) { | ||
| install(KtorServerTracing) { | ||
| setOpenTelemetry(testing.openTelemetry) | ||
| setSpanKindExtractor { | ||
| SpanKindExtractor { req -> | ||
| if (req.uri.startsWith("/from-pubsub/")) { | ||
| SpanKind.CONSUMER | ||
| } else { | ||
| SpanKind.SERVER | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| routing { | ||
| post(consumerKindEndpoint.path) { | ||
| call.respondText(consumerKindEndpoint.body, status = HttpStatusCode.fromValue(consumerKindEndpoint.status)) | ||
| } | ||
|
|
||
| post(serverKindEndpoint.path) { | ||
| call.respondText(serverKindEndpoint.body, status = HttpStatusCode.fromValue(serverKindEndpoint.status)) | ||
| } | ||
| } | ||
| }.start() | ||
| } | ||
|
|
||
| override fun stopServer(server: ApplicationEngine) { | ||
| server.stop(0, 10, TimeUnit.SECONDS) | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("provideArguments") | ||
| fun testSpanKindExtractor(endpoint: ServerEndpoint, expectedKind: SpanKind) { | ||
| val request = AggregatedHttpRequest.of(HttpMethod.valueOf("POST"), resolveAddress(endpoint)) | ||
| val response: AggregatedHttpResponse = client.execute(request).aggregate().join() | ||
| assertThat(response.status().code()).isEqualTo(endpoint.status) | ||
|
|
||
| testing.waitAndAssertTraces( | ||
| Consumer { trace -> | ||
| trace.hasSpansSatisfyingExactly( | ||
| Consumer { span -> | ||
| span.hasKind(expectedKind) | ||
| } | ||
| ) | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| private fun provideArguments(): Stream<Arguments> { | ||
| return Stream.of( | ||
| arguments(consumerKindEndpoint, SpanKind.CONSUMER), | ||
| arguments(serverKindEndpoint, SpanKind.SERVER), | ||
| ) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have not written any tests for this method, as there were no unit tests for the existing setStatusExtractor or addAttributeExtractor, is that ok?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have some integration tests that exercise the entire instrumentation module.
You could perhaps use the
AbstractHttpServerUsingTestandHttpServerInstrumentationExtensiondirectly and set up a simple HTTP server with one endpoint, just to verify that the span it emits has the span kind you want.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your detailed explanation, I added test cases in 959ee02.