Skip to content

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

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

Merged
merged 12 commits into from
Dec 20, 2024
+59 −21
Merged

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

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 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
e7381bb
update
cuichenli Dec 19, 2024
1120ad8
Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…
cuichenli Dec 19, 2024
807fd56
one more
cuichenli Dec 19, 2024
c1a5638
Update instrumentation/spring/spring-webflux/spring-webflux-5.0/javaa…
cuichenli Dec 19, 2024
d8d3837
update to get method name
cuichenli Dec 20, 2024
3810623
Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…
cuichenli Dec 20, 2024
930f0f4
Merge branch 'capture-code-attributes-spring-webflux' of github.com:c…
cuichenli Dec 20, 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
13 changes: 12 additions & 1 deletion ...try/javaagent/instrumentation/spring/webflux/v5_0/server/HandlerCodeAttributesGetter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,28 @@

import io.opentelemetry.instrumentation.api.incubator.semconv.code.CodeAttributesGetter;
import javax.annotation.Nullable;
import org.springframework.web.method.HandlerMethod;

public class HandlerCodeAttributesGetter implements CodeAttributesGetter<Object> {
@Nullable
@Override
public Class<?> getCodeClass(Object handler) {
return handler.getClass();
if (handler instanceof HandlerMethod) {
// Special case for requests mapped with annotations
HandlerMethod handlerMethod = (HandlerMethod) handler;
return handlerMethod.getMethod().getDeclaringClass();
} else {
return handler.getClass();
}
}

@Nullable
@Override
public String getMethodName(Object handler) {
if (handler instanceof HandlerMethod) {
HandlerMethod handlerMethod = (HandlerMethod) handler;
return handlerMethod.getMethod().getName();
}
Comment on lines +28 to +31
Copy link
Member

Choose a reason for hiding this comment

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

👍

return "handle";
}
}
8 changes: 3 additions & 5 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,11 +6,11 @@
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;
import io.opentelemetry.javaagent.bootstrap.internal.ExperimentalConfig;
import io.opentelemetry.javaagent.instrumentation.spring.webflux.v5_0.SpringWebfluxConfig;
import org.springframework.web.reactive.HandlerMapping;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.pattern.PathPattern;
Expand All @@ -25,13 +25,11 @@ public final class WebfluxSingletons {
Instrumenter.builder(
GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME, new WebfluxSpanNameExtractor());

if (SpringWebfluxConfig.captureExperimentalSpanAttributes()) {
builder.addAttributesExtractor(new ExperimentalAttributesExtractor());
}

INSTRUMENTER =
builder
.setEnabled(ExperimentalConfig.get().controllerTelemetryEnabled())
.addAttributesExtractor(
CodeAttributesExtractor.create(new HandlerCodeAttributesGetter()))
.buildInstrumenter();
}

Expand Down
59 changes: 44 additions & 15 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 @@ -5,7 +5,6 @@

package io.opentelemetry.javaagent.instrumentation.spring.webflux.v5_0.server;

import static io.opentelemetry.api.common.AttributeKey.stringKey;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
Expand All @@ -25,6 +24,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 @@ -139,7 +140,12 @@ void basicGetTest(Parameter parameter) {
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_FUNCTION,
parameter.annotatedMethod == null
? val -> val.isEqualTo("handle")
: val -> val.isEqualTo(parameter.annotatedMethod)),
satisfies(
CODE_NAMESPACE,
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

Copy link
Member Author

Choose a reason for hiding this comment

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

updated

Copy link
Contributor

Choose a reason for hiding this comment

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

now it reports TestController as class name and method name as handle, TestController does not have this method

Expand Down Expand Up @@ -258,7 +264,12 @@ void getAsyncResponseTest(Parameter parameter) {
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_FUNCTION,
parameter.annotatedMethod == null
? val -> val.isEqualTo("handle")
: val -> val.isEqualTo(parameter.annotatedMethod)),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
Expand Down Expand Up @@ -364,7 +375,12 @@ void createSpanDuringHandlerFunctionTest(Parameter parameter) {
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_FUNCTION,
parameter.annotatedMethod == null
? val -> val.isEqualTo("handle")
: val -> val.isEqualTo(parameter.annotatedMethod)),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
Expand Down Expand Up @@ -428,8 +444,9 @@ void get404Test() {
.hasStatus(StatusData.error())
.hasEventsSatisfyingExactly(SpringWebfluxTest::resource404Exception)
.hasAttributesSatisfyingExactly(
equalTo(CODE_FUNCTION, "handle"),
equalTo(
stringKey("spring-webflux.handler.type"),
CODE_NAMESPACE,
"org.springframework.web.reactive.resource.ResourceWebHandler"))));
}

Expand Down Expand Up @@ -485,9 +502,8 @@ void basicPostTest() {
.hasKind(SpanKind.INTERNAL)
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
val -> val.contains(EchoHandlerFunction.class.getName()))),
equalTo(CODE_FUNCTION, "handle"),
equalTo(CODE_NAMESPACE, "server.EchoHandlerFunction")),
span ->
span.hasName("echo").hasParent(trace.getSpan(1)).hasTotalAttributeCount(0)));
}
Expand Down Expand Up @@ -545,7 +561,12 @@ void getToBadEndpointTest(Parameter parameter) {
val -> val.isInstanceOf(String.class))))
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_FUNCTION,
parameter.annotatedMethod == null
? val -> val.isEqualTo("handle")
: val -> val.isEqualTo(parameter.annotatedMethod)),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
Expand Down Expand Up @@ -603,8 +624,9 @@ void redirectTest() {
.hasKind(SpanKind.INTERNAL)
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
equalTo(CODE_FUNCTION, "handle"),
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_NAMESPACE,
val -> val.startsWith("server.RedirectComponent$$Lambda")))),
trace ->
trace.hasSpansSatisfyingExactly(
Expand All @@ -631,8 +653,9 @@ void redirectTest() {
span.hasKind(SpanKind.INTERNAL)
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
equalTo(CODE_FUNCTION, "handle"),
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_NAMESPACE,
val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)));
}));
}
Expand Down Expand Up @@ -689,7 +712,12 @@ void multipleGetsToDelayingRoute(Parameter parameter) {
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
satisfies(
stringKey("spring-webflux.handler.type"),
CODE_FUNCTION,
parameter.annotatedMethod == null
? val -> val.isEqualTo("handle")
: val -> val.isEqualTo(parameter.annotatedMethod)),
satisfies(
CODE_NAMESPACE,
parameter.annotatedMethod == null
? val -> val.contains(INNER_HANDLER_FUNCTION_CLASS_TAG_PREFIX)
: val -> val.isEqualTo(TestController.class.getName())));
Expand Down Expand Up @@ -760,10 +788,11 @@ void cancelRequestTest() throws Exception {
.hasKind(SpanKind.INTERNAL)
.hasParent(trace.getSpan(0))
.hasAttributesSatisfyingExactly(
equalTo(CODE_FUNCTION, "handle"),
satisfies(
stringKey("spring-webflux.handler.type"),
value ->
value.startsWith(
CODE_NAMESPACE,
val ->
val.startsWith(
"server.SpringWebFluxTestApplication$$Lambda")))));

SpringWebFluxTestApplication.resumeSlowRequest();
Expand Down