Skip to content

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

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 7 commits into from
Sep 17, 2025
Merged

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

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
13adf93
Initial plan
Copilot Sep 15, 2025
540ac84
Add shouldStart checks to lettuce instrumentation span creation
Copilot Sep 15, 2025
60ac4bf
Add instrumentationEnabled configuration option and improve shouldSta…
Copilot Sep 15, 2025
6159891
Fix shouldStart pattern in lettuce-4.0 and lettuce-5.0 javaagent inst…
Copilot Sep 15, 2025
d95c3ac
Revert lettuce-5.1 changes as requested
Copilot Sep 15, 2025
d308b2b
Apply suggestions from code review
trask Sep 17, 2025
6750008
./gradlew spotlessApply
otelbot[bot] Sep 17, 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
8 changes: 7 additions & 1 deletion ...telemetry/javaagent/instrumentation/lettuce/v4_0/LettuceAsyncCommandsInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ public void end(
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);
// remember the context that called dispatch, it is used in LettuceAsyncCommandInstrumentation
context = context.with(LettuceSingletons.COMMAND_CONTEXT_KEY, parentContext);
Expand All @@ -75,7 +79,9 @@ public static void onExit(
@Advice.Thrown Throwable throwable,
@Advice.Return AsyncCommand<?, ?, ?> asyncCommand,
@Advice.Enter AdviceScope adviceScope) {
adviceScope.end(throwable, command, asyncCommand);
if (adviceScope != null) {
adviceScope.end(throwable, command, asyncCommand);
}
}
}
}
11 changes: 9 additions & 2 deletions ...o/opentelemetry/javaagent/instrumentation/lettuce/v4_0/LettuceConnectInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@ public void end(Throwable throwable, RedisURI redisUri) {

@Advice.OnMethodEnter(suppress = Throwable.class)
public static AdviceScope onEnter(@Advice.Argument(1) RedisURI redisUri) {
Context context = connectInstrumenter().start(currentContext(), redisUri);
Context parentContext = currentContext();
if (!connectInstrumenter().shouldStart(parentContext, redisUri)) {
return null;
}

Context context = connectInstrumenter().start(parentContext, redisUri);
return new AdviceScope(context, context.makeCurrent());
}

Expand All @@ -63,7 +68,9 @@ public static void onExit(
@Advice.Argument(1) RedisURI redisUri,
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter AdviceScope adviceScope) {
adviceScope.end(throwable, redisUri);
if (adviceScope != null) {
adviceScope.end(throwable, redisUri);
}
}
}
}
8 changes: 7 additions & 1 deletion ...telemetry/javaagent/instrumentation/lettuce/v5_0/LettuceAsyncCommandsInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ public void end(
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);
// remember the context that called dispatch, it is used in LettuceAsyncCommandInstrumentation
context = context.with(LettuceSingletons.COMMAND_CONTEXT_KEY, parentContext);
Expand All @@ -88,7 +92,9 @@ public static void stopSpan(
@Advice.Return AsyncCommand<?, ?, ?> asyncCommand,
@Advice.Enter AdviceScope adviceScope) {

adviceScope.end(throwable, command, asyncCommand);
if (adviceScope != null) {
adviceScope.end(throwable, command, asyncCommand);
}
}
}
}
11 changes: 9 additions & 2 deletions ...io/opentelemetry/javaagent/instrumentation/lettuce/v5_0/LettuceClientInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,12 @@ public void end(

@Advice.OnMethodEnter(suppress = Throwable.class)
public static AdviceScope onEnter(@Advice.Argument(1) RedisURI redisUri) {
Context context = connectInstrumenter().start(currentContext(), redisUri);
Context parentContext = currentContext();
if (!connectInstrumenter().shouldStart(parentContext, redisUri)) {
return null;
}

Context context = connectInstrumenter().start(parentContext, redisUri);
return new AdviceScope(context, context.makeCurrent());
}

Expand All @@ -82,7 +87,9 @@ public static void stopSpan(
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Return ConnectionFuture<?> connectionFuture,
@Advice.Enter AdviceScope adviceScope) {
adviceScope.end(throwable, redisUri, connectionFuture);
if (adviceScope != null) {
adviceScope.end(throwable, redisUri, connectionFuture);
}
}
}
}
Loading