Skip to content

add nullaway to spring jms (part 2) #15409

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add nullaway to spring jms (part 2) #15409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4659c0c
add nullaway
zeitlinger Nov 20, 2025
d3e31d6
add nullaway
zeitlinger Nov 21, 2025
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: 2 additions & 1 deletion .../src/main/java/io/opentelemetry/javaagent/instrumentation/jms/MessageWithDestination.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.jms;

import com.google.auto.value.AutoValue;
import javax.annotation.Nullable;

@AutoValue
public abstract class MessageWithDestination {
Expand All @@ -20,7 +21,7 @@ public abstract class MessageWithDestination {
public abstract boolean isTemporaryDestination();

public static MessageWithDestination create(
MessageAdapter message, DestinationAdapter fallbackDestination) {
MessageAdapter message, @Nullable DestinationAdapter fallbackDestination) {
DestinationAdapter jmsDestination = null;
try {
jmsDestination = message.getJmsDestination();
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-jms/spring-jms-2.0/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
id("otel.javaagent-instrumentation")
id("otel.nullaway-conventions")
}

muzzle {
Expand Down
2 changes: 2 additions & 0 deletions ...strumentation/spring/jms/v2_0/AbstractPollingMessageListenerContainerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import io.opentelemetry.javaagent.bootstrap.jms.JmsReceiveContextHolder;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
Expand All @@ -34,6 +35,7 @@ public void transform(TypeTransformer transformer) {
public static class ReceiveAndExecuteAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
@Nullable
public static Scope onEnter() {
if (isReceiveTelemetryEnabled()) {
Context context = JmsReceiveContextHolder.init(Java8BytecodeBridge.currentContext());
Expand Down
3 changes: 3 additions & 0 deletions ...etry/javaagent/instrumentation/spring/jms/v2_0/JmsDestinationAccessorInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
Expand All @@ -37,11 +38,13 @@ public void transform(TypeTransformer transformer) {
public static class ReceiveAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
@Nullable
public static Scope onEnter() {
if (isReceiveTelemetryEnabled()) {
return null;
}
// suppress receive span creation in jms instrumentation
@SuppressWarnings("NullAway") // request is typed as Void
Copy link
Member

@jaydeluca jaydeluca Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

i wonder if it would make sense to add @Nullable to the parameter in suppressSpan (and all the other downstream effects of that) to avoid having to suppress this?

Copy link
Member Author

@zeitlinger zeitlinger Nov 21, 2025

Choose a reason for hiding this comment

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

I tried that - and it's not working (have to look up the details if required)

Copy link
Member

@trask trask Nov 21, 2025

Choose a reason for hiding this comment

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

can you check? I'm asking because the reason "request is typed as Void" doesn't really seem correct here. Rather the reason seems that the method really does accept Nullable.

Copy link
Contributor

@laurit laurit Nov 21, 2025

Choose a reason for hiding this comment

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

InstrumenterUtil.suppressSpan() calls spanKindExtractor.extract(request) which doesn't accept a null request. Here it works because the instrumenter uses SpanKindExtractor.alwaysConsumer() that doesn't use the request.
The comment // request is typed as Void is misleading as here request is MessageWithDestination and the response is Void.

Context context =
InstrumenterUtil.suppressSpan(
receiveInstrumenter(), Java8BytecodeBridge.currentContext(), null);
Expand Down
3 changes: 2 additions & 1 deletion ...ry/javaagent/instrumentation/spring/jms/v2_0/SpringJmsMessageListenerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,14 @@ public static AdviceScope enter(Message message) {
return new AdviceScope(request, context, context.makeCurrent());
}

public void exit(Throwable throwable) {
public void exit(@Nullable Throwable throwable) {
scope.close();
listenerInstrumenter().end(context, request, null, throwable);
}
}

@Advice.OnMethodEnter(suppress = Throwable.class)
@Nullable
public static AdviceScope onEnter(@Advice.Argument(0) Message message) {
return AdviceScope.enter(message);
}
Expand Down
1 change: 1 addition & 0 deletions instrumentation/spring/spring-jms/spring-jms-6.0/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
id("otel.javaagent-instrumentation")
id("otel.nullaway-conventions")
}

muzzle {
Expand Down
2 changes: 2 additions & 0 deletions ...strumentation/spring/jms/v6_0/AbstractPollingMessageListenerContainerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import io.opentelemetry.javaagent.bootstrap.jms.JmsReceiveContextHolder;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
Expand All @@ -34,6 +35,7 @@ public void transform(TypeTransformer transformer) {
public static class ReceiveAndExecuteAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
@Nullable
public static Scope onEnter() {
if (isReceiveTelemetryEnabled()) {
Context context = JmsReceiveContextHolder.init(Java8BytecodeBridge.currentContext());
Expand Down
3 changes: 3 additions & 0 deletions ...etry/javaagent/instrumentation/spring/jms/v6_0/JmsDestinationAccessorInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
Expand All @@ -37,11 +38,13 @@ public void transform(TypeTransformer transformer) {
public static class ReceiveAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
@Nullable
public static Scope onEnter() {
if (isReceiveTelemetryEnabled()) {
return null;
}
// suppress receive span creation in jms instrumentation
@SuppressWarnings("NullAway") // request is typed as Void
Context context =
InstrumenterUtil.suppressSpan(
receiveInstrumenter(), Java8BytecodeBridge.currentContext(), null);
Expand Down
2 changes: 1 addition & 1 deletion ...ry/javaagent/instrumentation/spring/jms/v6_0/SpringJmsMessageListenerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public static AdviceScope enter(Message message) {
return new AdviceScope(request, context, context.makeCurrent());
}

public void exit(Throwable throwable) {
public void exit(@Nullable Throwable throwable) {
scope.close();
listenerInstrumenter().end(context, request, null, throwable);
}
Expand Down
Loading