Can't use `@SpanAttribute` annotation with Websockets.NEXT `@OnTextMessage` #43412

edeandrea · 2024-09-20T15:32:02Z

Describe the bug

When combining WebSockets.NEXT & OpenTelemetry, I can't seem to be able to add an @SpanAttribute annotation to a method parameter of an @OnTextMessage, like this:

@OnTextMessage
@WithSpan("ChatMessage")
public ClaimBotQueryResponse onMessage(@SpanAttribute("arg.chatQuery") ClaimBotQuery query) {
    Log.infof("Got chat query: %s", query);
    var response = new ClaimBotQueryResponse("token", this.bot.chat(query), "");
    Log.debugf("Got chat response: %s", response);

    return response;
}

Expected behavior

No response

Actual behavior

I get this error when trying to run dev mode:

2024-09-20 11:21:44,087 ERROR [io.qua.dep.dev.IsolatedDevModeMain] (main) Failed to start quarkus: java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
        [error]: Build step io.quarkus.websockets.next.deployment.WebSocketProcessor#collectEndpoints threw an exception: io.quarkus.websockets.next.WebSocketException: Unable to inject @OnTextMessage callback parameter 'query' declared on org.parasol.resources.ClaimWebsocketChatBot#onMessage(): no injector found
        at io.quarkus.websockets.next.deployment.Callback.collectArguments(Callback.java:208)
        at io.quarkus.websockets.next.deployment.Callback.<init>(Callback.java:65)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.findCallback(WebSocketProcessor.java:1425)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.findCallback(WebSocketProcessor.java:1410)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.collectEndpoints(WebSocketProcessor.java:355)
        at java.base/java.lang.invoke.MethodHandle.invokeWithArguments(MethodHandle.java:733)
        at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:856)
        at io.quarkus.builder.BuildContext.run(BuildContext.java:256)
        at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
        at org.jboss.threads.EnhancedQueueExecutor$Task.doRunWith(EnhancedQueueExecutor.java:2516)
        at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2495)
        at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1521)
        at java.base/java.lang.Thread.run(Thread.java:1583)
        at org.jboss.threads.JBossThread.run(JBossThread.java:483)

        at io.quarkus.runner.bootstrap.AugmentActionImpl.runAugment(AugmentActionImpl.java:354)
        at io.quarkus.runner.bootstrap.AugmentActionImpl.createInitialRuntimeApplication(AugmentActionImpl.java:272)
        at io.quarkus.runner.bootstrap.AugmentActionImpl.createInitialRuntimeApplication(AugmentActionImpl.java:62)
        at io.quarkus.deployment.dev.IsolatedDevModeMain.firstStart(IsolatedDevModeMain.java:91)
        at io.quarkus.deployment.dev.IsolatedDevModeMain.accept(IsolatedDevModeMain.java:430)
        at io.quarkus.deployment.dev.IsolatedDevModeMain.accept(IsolatedDevModeMain.java:57)
        at io.quarkus.bootstrap.app.CuratedApplication.runInCl(CuratedApplication.java:138)
        at io.quarkus.bootstrap.app.CuratedApplication.runInAugmentClassLoader(CuratedApplication.java:93)
        at io.quarkus.deployment.dev.DevModeMain.start(DevModeMain.java:131)
        at io.quarkus.deployment.dev.DevModeMain.main(DevModeMain.java:62)
Caused by: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
        [error]: Build step io.quarkus.websockets.next.deployment.WebSocketProcessor#collectEndpoints threw an exception: io.quarkus.websockets.next.WebSocketException: Unable to inject @OnTextMessage callback parameter 'query' declared on org.parasol.resources.ClaimWebsocketChatBot#onMessage(): no injector found
        at io.quarkus.websockets.next.deployment.Callback.collectArguments(Callback.java:208)
        at io.quarkus.websockets.next.deployment.Callback.<init>(Callback.java:65)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.findCallback(WebSocketProcessor.java:1425)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.findCallback(WebSocketProcessor.java:1410)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.collectEndpoints(WebSocketProcessor.java:355)
        at java.base/java.lang.invoke.MethodHandle.invokeWithArguments(MethodHandle.java:733)
        at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:856)
        at io.quarkus.builder.BuildContext.run(BuildContext.java:256)
        at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
        at org.jboss.threads.EnhancedQueueExecutor$Task.doRunWith(EnhancedQueueExecutor.java:2516)
        at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2495)
        at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1521)
        at java.base/java.lang.Thread.run(Thread.java:1583)
        at org.jboss.threads.JBossThread.run(JBossThread.java:483)

        at io.quarkus.builder.Execution.run(Execution.java:123)
        at io.quarkus.builder.BuildExecutionBuilder.execute(BuildExecutionBuilder.java:79)
        at io.quarkus.deployment.QuarkusAugmentor.run(QuarkusAugmentor.java:161)
        at io.quarkus.runner.bootstrap.AugmentActionImpl.runAugment(AugmentActionImpl.java:350)
        ... 9 more
Caused by: io.quarkus.websockets.next.WebSocketException: Unable to inject @OnTextMessage callback parameter 'query' declared on org.parasol.resources.ClaimWebsocketChatBot#onMessage(): no injector found
        at io.quarkus.websockets.next.deployment.Callback.collectArguments(Callback.java:208)
        at io.quarkus.websockets.next.deployment.Callback.<init>(Callback.java:65)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.findCallback(WebSocketProcessor.java:1425)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.findCallback(WebSocketProcessor.java:1410)
        at io.quarkus.websockets.next.deployment.WebSocketProcessor.collectEndpoints(WebSocketProcessor.java:355)
        at java.base/java.lang.invoke.MethodHandle.invokeWithArguments(MethodHandle.java:733)
        at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:856)
        at io.quarkus.builder.BuildContext.run(BuildContext.java:256)
        at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
        at org.jboss.threads.EnhancedQueueExecutor$Task.doRunWith(EnhancedQueueExecutor.java:2516)
        at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2495)
        at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1521)
        at java.base/java.lang.Thread.run(Thread.java:1583)
        at org.jboss.threads.JBossThread.run(JBossThread.java:483)

How to Reproduce?

Reproducer: parasol-insurance.zip

Download & unzip reproducer
cd parasol-insurance
./mvnw clean quarkus:dev
Observe above stack trace

Output of `uname -a` or `ver`

Darwin edeandrea-m1pro 24.0.0 Darwin Kernel Version 24.0.0: Mon Aug 12 20:51:54 PDT 2024; root:xnu-11215.1.10~2/RELEASE_ARM64_T6000 arm64

Output of `java -version`

openjdk version "21.0.4" 2024-07-16 LTS
OpenJDK Runtime Environment Temurin-21.0.4+7 (build 21.0.4+7-LTS)
OpenJDK 64-Bit Server VM Temurin-21.0.4+7 (build 21.0.4+7-LTS, mixed mode)

Quarkus version or git rev

3.14.4

Build tool (ie. output of `mvnw --version` or `gradlew --version`)

Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae)
Maven home: /Users/edeandre/.m2/wrapper/dists/apache-maven-3.9.6/a53741d1
Java version: 21.0.4, vendor: Eclipse Adoptium, runtime: /Users/edeandre/.sdkman/candidates/java/21.0.4-tem
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "15.0", arch: "aarch64", family: "mac"

Additional information

No response

The text was updated successfully, but these errors were encountered:

geoand · 2024-09-21T05:41:14Z

cc @brunobat @mkouba @michalvavrik

mkouba · 2024-09-23T09:39:21Z

When combining WebSockets.NEXT & OpenTelemetry, I can't seem to be able to add an @SpanAttribute annotation to a method parameter of an @OnTextMessage, like this:

@edeandrea OpenTelemetry is not fully supported yet. There's an open enhancement issue: #39143

geoand · 2024-09-23T09:40:21Z

@mkouba should we close this as a duplicate of #39143?

mkouba · 2024-09-23T09:53:51Z

@mkouba should we close this as a duplicate of #39143?

I'd keep this issue open for now (unless Bruno and Michal object). I don't know how the @WithSpan + @SpanAttribute("arg.chatQuery") combo works and it could be also out of scope of #39143 🤷.

brunobat · 2024-09-24T13:20:36Z

@SpanAttribute() just adds the value of a particular method parameter to the span, as an attribute.
It's syntactic sugar.

mkouba · 2024-09-24T14:45:17Z

@SpanAttribute() just adds the value of a particular method parameter to the span, as an attribute. It's syntactic sugar.

Well, but it depens on how it's implemented. In WS Next the validation would most likely fail because it's an unsupported method parameter. I guess that normally it's "injected" by the interceptor, right?

brunobat · 2024-09-24T15:05:55Z

@SpanAttribute() just adds the value of a particular method parameter to the span, as an attribute. It's syntactic sugar.

Well, but it depens on how it's implemented. In WS Next the validation would most likely fail because it's an unsupported method parameter. I guess that normally it's "injected" by the interceptor, right?

This comes from the OTel spec. The annotation is just used to extract, in the example above, the following key pair and place it in the attributes of the span: arg.chatQuery=${query}, however, the query value must be a string... Not sure what will happen when used with ClaimBotQuery, @edeandrea.

edeandrea · 2024-09-24T15:13:53Z

Not sure what will happen when used with ClaimBotQuery, @edeandrea.

Wouldn't/shouldn't it just call .toString()? Thats what I see when I do similar things in other places.

mkouba · 2024-09-24T16:36:10Z

@SpanAttribute() just adds the value of a particular method parameter to the span, as an attribute. It's syntactic sugar.

Well, but it depens on how it's implemented. In WS Next the validation would most likely fail because it's an unsupported method parameter. I guess that normally it's "injected" by the interceptor, right?

This comes from the OTel spec. The annotation is just used to extract, in the example above, the following key pair and place it in the attributes of the span: arg.chatQuery=${query}, however, the query value must be a string... Not sure what will happen when used with ClaimBotQuery, @edeandrea.

I do understand that it's mandated by the spec. What I'm saying is that the validation of the WS next callback method will fail because it has some special requirements. I was asking about the implementation because a regular CDI interceptor would not work.

cescoffier · 2024-11-25T06:44:30Z

@mkouba @brunobat anything new about this one?

brunobat · 2024-11-25T08:34:49Z

Still on the backlog and no plans to develop it soon.

edeandrea added the kind/bug Something isn't working label Sep 20, 2024

quarkus-bot bot added the triage/needs-triage label Sep 20, 2024

geoand added area/websockets area/tracing and removed triage/needs-triage labels Sep 21, 2024

geoand added kind/enhancement New feature or request and removed kind/bug Something isn't working labels Sep 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Can't use `@SpanAttribute` annotation with Websockets.NEXT `@OnTextMessage` #43412

Can't use `@SpanAttribute` annotation with Websockets.NEXT `@OnTextMessage` #43412

edeandrea commented Sep 20, 2024 •

edited

Loading

geoand commented Sep 21, 2024 •

edited by mkouba

Loading

mkouba commented Sep 23, 2024

geoand commented Sep 23, 2024

mkouba commented Sep 23, 2024

brunobat commented Sep 24, 2024

mkouba commented Sep 24, 2024

brunobat commented Sep 24, 2024 •

edited

Loading

edeandrea commented Sep 24, 2024

mkouba commented Sep 24, 2024

cescoffier commented Nov 25, 2024

brunobat commented Nov 25, 2024

Can't use @SpanAttribute annotation with Websockets.NEXT @OnTextMessage #43412

Can't use @SpanAttribute annotation with Websockets.NEXT @OnTextMessage #43412

Comments

edeandrea commented Sep 20, 2024 • edited Loading

Describe the bug

Expected behavior

Actual behavior

How to Reproduce?

Output of uname -a or ver

Output of java -version

Quarkus version or git rev

Build tool (ie. output of mvnw --version or gradlew --version)

Additional information

geoand commented Sep 21, 2024 • edited by mkouba Loading

mkouba commented Sep 23, 2024

geoand commented Sep 23, 2024

mkouba commented Sep 23, 2024

brunobat commented Sep 24, 2024

mkouba commented Sep 24, 2024

brunobat commented Sep 24, 2024 • edited Loading

edeandrea commented Sep 24, 2024

mkouba commented Sep 24, 2024

cescoffier commented Nov 25, 2024

brunobat commented Nov 25, 2024

Can't use `@SpanAttribute` annotation with Websockets.NEXT `@OnTextMessage` #43412

Can't use `@SpanAttribute` annotation with Websockets.NEXT `@OnTextMessage` #43412

edeandrea commented Sep 20, 2024 •

edited

Loading

Output of `uname -a` or `ver`

Output of `java -version`

Build tool (ie. output of `mvnw --version` or `gradlew --version`)

geoand commented Sep 21, 2024 •

edited by mkouba

Loading

brunobat commented Sep 24, 2024 •

edited

Loading