Skip to content
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.

Sign up for GitHub

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

Add code attributes to spring webflux controller spans and remove spring-webflux.handler.type #12887

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+33 −24
Open

Add code attributes to spring webflux controller spans and remove spring-webflux.handler.type #12887

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24b443c
capture code.* resources attributes
cuichenli Dec 13, 2024
ee2c31e
remove redundant metric
cuichenli Dec 16, 2024
8e8fbbb
Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…
cuichenli Dec 16, 2024
33ec295
fix check style error
cuichenli Dec 17, 2024
7043602
Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…
cuichenli Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/WebfluxSingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package io.opentelemetry.javaagent.instrumentation.spring.webflux.v5_0.server;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.instrumentation.api.incubator.semconv.code.CodeAttributesExtractor;
import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
import io.opentelemetry.instrumentation.api.semconv.http.HttpServerRouteGetter;
Expand All @@ -32,6 +33,8 @@ public final class WebfluxSingletons {
INSTRUMENTER =
builder
.setEnabled(ExperimentalConfig.get().controllerTelemetryEnabled())
.addAttributesExtractor(
CodeAttributesExtractor.create(new HandlerCodeAttributesGetter()))
.buildInstrumenter();
}

Expand Down
66 changes: 60 additions & 6 deletions ...opentelemetry/javaagent/instrumentation/spring/webflux/v5_0/server/SpringWebfluxTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
import static io.opentelemetry.semconv.UrlAttributes.URL_PATH;
import static io.opentelemetry.semconv.UrlAttributes.URL_SCHEME;
import static io.opentelemetry.semconv.UserAgentAttributes.USER_AGENT_ORIGINAL;
import static io.opentelemetry.semconv.incubating.CodeIncubatingAttributes.CODE_FUNCTION;
import static io.opentelemetry.semconv.incubating.CodeIncubatingAttributes.CODE_NAMESPACE;
import static org.junit.jupiter.api.Named.named;

import io.opentelemetry.api.trace.SpanKind;
Expand Down Expand Up @@ -142,7 +144,13 @@ void basicGetTest(Parameter parameter) {
stringKey("spring-webflux.handler.type"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is spring-webflux.handler.type redundant now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i think it is redundant now. but not sure what is the recommended procedure of deprecating a metric? can we just remove it or we should mark it deprecated and remove it in a future release? thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since it's already an opt-in experimental attribute, I think it's ok to just remove it and mention in the PR title so that I will remember to add it in the migration notes when writing the change log

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i have removed it in the latest change, and updated the title. please kindly have a look. thanks!

parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previously used TestController is more useful than org.springframework.web.method.HandlerMethod that is reported after these changes

: val -> val.isEqualTo(TestController.class.getName())),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.endsWith("HandlerMethod")));
}));
}

Expand Down Expand Up @@ -261,7 +269,13 @@ void getAsyncResponseTest(Parameter parameter) {
stringKey("spring-webflux.handler.type"),
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
: val -> val.isEqualTo(TestController.class.getName())),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.endsWith("HandlerMethod")));
},
span ->
span.hasName("tracedMethod")
Expand Down Expand Up @@ -367,7 +381,13 @@ void createSpanDuringHandlerFunctionTest(Parameter parameter) {
stringKey("spring-webflux.handler.type"),
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
: val -> val.isEqualTo(TestController.class.getName())),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.endsWith("HandlerMethod")));
},
span ->
span.hasName("tracedMethod")
Expand Down Expand Up @@ -430,6 +450,10 @@ void get404Test() {
.hasAttributesSatisfyingExactly(
equalTo(
stringKey("spring-webflux.handler.type"),
"org.springframework.web.reactive.resource.ResourceWebHandler"),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
equalTo(
CODE_NAMESPACE,
"org.springframework.web.reactive.resource.ResourceWebHandler"))));
}

Expand Down Expand Up @@ -487,7 +511,11 @@ void basicPostTest() {
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
val -> val.contains(EchoHandlerFunction.class.getName()))),
val -> val.contains(EchoHandlerFunction.class.getName())),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you are testing for exact value use equalTo(CODE_FUNCTION, "handle") instead of satisfies

satisfies(
CODE_NAMESPACE,
val -> val.isEqualTo("server.EchoHandlerFunction"))),
span ->
span.hasName("echo").hasParent(trace.getSpan(1)).hasTotalAttributeCount(0)));
}
Expand Down Expand Up @@ -548,7 +576,13 @@ void getToBadEndpointTest(Parameter parameter) {
stringKey("spring-webflux.handler.type"),
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
: val -> val.isEqualTo(TestController.class.getName())),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.endsWith("HandlerMethod")));
}));
}

Expand Down Expand Up @@ -605,6 +639,10 @@ void redirectTest() {
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
val -> val.startsWith("server.RedirectComponent$$Lambda")),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
val -> val.startsWith("server.RedirectComponent$$Lambda")))),
trace ->
trace.hasSpansSatisfyingExactly(
Expand Down Expand Up @@ -633,6 +671,10 @@ void redirectTest() {
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)));
}));
}
Expand Down Expand Up @@ -692,7 +734,13 @@ void multipleGetsToDelayingRoute(Parameter parameter) {
stringKey("spring-webflux.handler.type"),
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
: val -> val.isEqualTo(TestController.class.getName())),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.endsWith("HandlerMethod")));
});

testing.waitAndAssertTraces(Collections.nCopies(requestsCount, traceAssertion));
Expand Down Expand Up @@ -764,6 +812,12 @@ void cancelRequestTest() throws Exception {
stringKey("spring-webflux.handler.type"),
value ->
value.startsWith(
"server.SpringWebFluxTestApplication$$Lambda")),
satisfies(CODE_FUNCTION, val -> val.isEqualTo("handle")),
satisfies(
CODE_NAMESPACE,
val ->
val.startsWith(
"server.SpringWebFluxTestApplication$$Lambda")))));

SpringWebFluxTestApplication.resumeSlowRequest();
Expand Down
Loading