-
Notifications
You must be signed in to change notification settings - Fork 1k
Fix double end() calls in KtorServerTelemetry
#15452
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
Merged
trask
merged 3 commits into
open-telemetry:main
from
marychatte:marychatte/fix-negative-active-request-ktor
Dec 1, 2025
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 hidden or 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
This file contains hidden or 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
This file contains hidden or 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
120 changes: 120 additions & 0 deletions
120
...brary/src/test/kotlin/io/opentelemetry/instrumentation/ktor/v3_0/KtorServerMetricsTest.kt
This file contains hidden or 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,120 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.ktor.v3_0 | ||
|
|
||
| import io.ktor.http.* | ||
| import io.ktor.server.application.* | ||
| import io.ktor.server.engine.* | ||
| import io.ktor.server.netty.* | ||
| import io.ktor.server.response.* | ||
| import io.ktor.server.routing.* | ||
| import io.opentelemetry.instrumentation.ktor.v2_0.common.internal.Experimental | ||
| import io.opentelemetry.instrumentation.ktor.v3_0.InstrumentationProperties.INSTRUMENTATION_NAME | ||
| 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.sdk.metrics.data.MetricData | ||
| import io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions | ||
| import io.opentelemetry.semconv.HttpAttributes | ||
| import io.opentelemetry.semconv.UrlAttributes | ||
| import io.opentelemetry.testing.internal.armeria.common.AggregatedHttpRequest | ||
| import io.opentelemetry.testing.internal.armeria.common.HttpMethod | ||
| import org.assertj.core.api.ThrowingConsumer | ||
| 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.stream.Stream | ||
|
|
||
| class KtorServerMetricsTest : AbstractHttpServerUsingTest<EmbeddedServer<*, *>>() { | ||
| companion object { | ||
| @JvmStatic | ||
| @RegisterExtension | ||
| val testing: InstrumentationExtension = HttpServerInstrumentationExtension.forLibrary() | ||
| } | ||
|
|
||
| private val errorDuringSendEndpoint = ServerEndpoint("errorDuringSend", "error-during-send", 500, "") | ||
| private val errorAfterSendEndpoint = ServerEndpoint("errorAfterSend", "error-after-send", 200, "") | ||
|
|
||
| @BeforeAll | ||
| fun setupOptions() { | ||
| startServer() | ||
| } | ||
|
|
||
| @AfterAll | ||
| fun cleanup() { | ||
| cleanupServer() | ||
| } | ||
|
|
||
| override fun getContextPath() = "" | ||
|
|
||
| override fun setupServer(): EmbeddedServer<*, *> = embeddedServer(Netty, port = port) { | ||
| install(KtorServerTelemetry) { | ||
| setOpenTelemetry(testing.openTelemetry) | ||
| Experimental.emitExperimentalTelemetry(this) | ||
| } | ||
|
|
||
| routing { | ||
| get(errorDuringSendEndpoint.path) { | ||
| call.respondBytesWriter { | ||
| throw IllegalArgumentException("exception") | ||
| } | ||
| } | ||
| get(errorAfterSendEndpoint.path) { | ||
| call.respondText(errorAfterSendEndpoint.body, status = HttpStatusCode.fromValue(errorAfterSendEndpoint.status)) | ||
| throw IllegalArgumentException("exception") | ||
| } | ||
| } | ||
| }.start() | ||
|
|
||
| override fun stopServer(server: EmbeddedServer<*, *>) { | ||
| server.stop(0, 10, TimeUnit.SECONDS) | ||
| } | ||
|
|
||
| // regression test for | ||
| // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/15303 | ||
| // verify that active requests are counted correctly when there is a send error | ||
| @ParameterizedTest | ||
| @MethodSource("provideArguments") | ||
| fun testActiveRequestsMetric(endpoint: ServerEndpoint) { | ||
| val request = AggregatedHttpRequest.of(HttpMethod.valueOf("GET"), resolveAddress(endpoint)) | ||
| try { | ||
| client.execute(request).aggregate().join() | ||
| } catch (_: Throwable) { | ||
| // we expect server error | ||
| } | ||
|
|
||
| testing.waitAndAssertMetrics( | ||
| INSTRUMENTATION_NAME, | ||
| "http.server.active_requests" | ||
| ) { metrics -> | ||
| metrics!!.anySatisfy(ThrowingConsumer { metric: MetricData? -> | ||
| OpenTelemetryAssertions.assertThat(metric) | ||
| .hasDescription("Number of active HTTP server requests.") | ||
| .hasUnit("{requests}") | ||
| .hasLongSumSatisfying { sum -> | ||
| sum.hasPointsSatisfying({ point -> | ||
| point.hasValue(0) | ||
| .hasAttributesSatisfying { | ||
| OpenTelemetryAssertions.equalTo(HttpAttributes.HTTP_REQUEST_METHOD, "GET") | ||
| OpenTelemetryAssertions.equalTo(UrlAttributes.URL_PATH, endpoint.path) | ||
| } | ||
| }) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| private fun provideArguments(): Stream<Arguments> = Stream.of( | ||
| arguments(errorDuringSendEndpoint), | ||
| arguments(errorAfterSendEndpoint), | ||
| ) | ||
| } | ||
Oops, something went wrong.
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.
could you add a comment that describes why this is added. Something like