Add shouldStart checks to lettuce-4.0 and lettuce-5.0 javaagent instrumentation to prevent span creation when disabled

[Copilot]

The lettuce javaagent instrumentations (versions 4.0 and 5.0) were creating spans even when instrumentation was disabled, bypassing the standard shouldStart pattern used by other OpenTelemetry instrumentations. This resulted in unnecessary span creation overhead and inconsistent behavior.

Problem

The lettuce javaagent instrumentations (versions 4.0 and 5.0) were directly creating spans without checking if instrumentation should be enabled:

Javaagent Instrumentation (lettuce-4.0, lettuce-5.0):

// Before: Always created spans regardless of instrumentation state
@Advice.OnMethodEnter(suppress = Throwable.class)
public static AdviceScope onEnter(@Advice.Argument(0) RedisCommand<?, ?, ?> command) {
  Context context = instrumenter().start(parentContext, command); // No shouldStart check
  return new AdviceScope(context, context.makeCurrent());
}

This meant spans would be created even when users wanted to disable lettuce instrumentation, leading to:

• Unnecessary performance overhead
• Inability to disable instrumentation programmatically
• Inconsistency with other OpenTelemetry instrumentations

Solution

Added proper shouldStart checks using the standard Instrumenter pattern consistent with other OpenTelemetry instrumentations:

Javaagent Instrumentation (lettuce-4.0, lettuce-5.0):

// After: Check shouldStart before creating spans
@Advice.OnMethodEnter(suppress = Throwable.class)
public static AdviceScope onEnter(@Advice.Argument(0) RedisCommand<?, ?, ?> command) {
  Context parentContext = currentContext();
  if (!instrumenter().shouldStart(parentContext, command)) {
    return null;
  }
  Context context = instrumenter().start(parentContext, command);
  return new AdviceScope(context, context.makeCurrent());
}

Key Changes

Javaagent Instrumentation (lettuce-4.0, lettuce-5.0):

1. Added shouldStart checks: Modified LettuceAsyncCommandsInstrumentation and connect instrumentation classes to check shouldStart before creating spans
2. Null-safe exit handling: Added proper null checks in exit methods to handle disabled instrumentation
3. Consistent pattern: Applied the same pattern used in JSP, Geode, and other javaagent instrumentations

Usage

Javaagent Usage (lettuce-4.0, lettuce-5.0):
The javaagent instrumentations now respect the standard OpenTelemetry instrumentation enablement configuration and will not create spans when instrumentation is disabled.

The implementation follows the same pattern used in other instrumentations like Ratpack, JSP, and Geode, ensuring consistency across the OpenTelemetry Java instrumentation ecosystem.

Fixes #14665.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

@trask 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

[trask]

worth a try 🤷‍♂️

[trask]

@copilot this issue is about lettuce-4.0, not lettuce-5.1

[Copilot]

@copilot this issue is about lettuce-4.0, not lettuce-5.1

You're absolutely right - the issue is about lettuce-4.0, not lettuce-5.1. I was working on the wrong version. I'm now focusing on fixing the shouldStart pattern in lettuce-4.0 (and lettuce-5.0 which has the same issue) javaagent instrumentation files. The lettuce-5.1 version uses library instrumentation which already follows the correct pattern.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• scans-in.gradle.com
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-opens=java.base/java.nio.charset=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.xml/javax.xml.namespace=ALL-UNNAMED -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 -Duser.country -Duser.language=en -Duser.variant -cp /home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/gradle-daemon-main-9.0.0.jar -javaagent:/home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/agents/gradle-instrumentation-agent-9.0.0.jar org.gradle.launcher.daemon.bootstrap.GradleDaemon 9.0.0 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[trask]

@copilot revert the changes to lettuce-5.1

[Copilot]

@copilot revert the changes to lettuce-5.1

Done! I've reverted all lettuce-5.1 changes as requested (commit d95c3ac). The fix now focuses solely on lettuce-4.0 and lettuce-5.0 javaagent instrumentations, which is what the original issue #14665 was about.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• scans-in.gradle.com
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-opens=java.base/java.nio.charset=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.xml/javax.xml.namespace=ALL-UNNAMED -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 -Duser.country -Duser.language=en -Duser.variant -cp /home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/gradle-daemon-main-9.0.0.jar -javaagent:/home/REDACTED/.gradle/wrapper/dists/gradle-9.0.0-bin/d6wjpkvcgsg3oed0qlfss3wgl/gradle-9.0.0/lib/agents/gradle-instrumentation-agent-9.0.0.jar org.gradle.launcher.daemon.bootstrap.GradleDaemon 9.0.0 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[SylvainJuge]

LGTM, just a few minor suggestions to add @Nullable where relevant in the modified code.

[otelbot-java-instrumentation]

🔧 The result from spotlessApply was committed to the PR branch.