Skip to content

Add call depth check to executor instrumentation #14546

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

Add call depth check to executor instrumentation #14546

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5191434
Add call depth check to executor instrumentation
laurit Aug 29, 2025
23d97f1
use class of the executor
laurit Sep 1, 2025
0466110
Merge branch 'main' into executor-call-depth
laurit Sep 1, 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
61 changes: 53 additions & 8 deletions ...ava/io/opentelemetry/javaagent/instrumentation/executors/JavaExecutorInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.util.VirtualField;
import io.opentelemetry.javaagent.bootstrap.CallDepth;
import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
import io.opentelemetry.javaagent.bootstrap.executors.ContextPropagatingRunnable;
import io.opentelemetry.javaagent.bootstrap.executors.ExecutorAdviceHelper;
Expand Down Expand Up @@ -89,7 +90,13 @@ public static class SetExecuteRunnableStateAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
public static PropagatedContext enterJobSubmit(
@Advice.Argument(value = 0, readOnly = false) Runnable task) {
@Advice.This Object executor,
@Advice.Argument(value = 0, readOnly = false) Runnable task,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
callDepth = CallDepth.forClass(executor.getClass());
if (callDepth.getAndIncrement() > 0) {
return null;
}
Context context = Java8BytecodeBridge.currentContext();
if (!ExecutorAdviceHelper.shouldPropagateContext(context, task)) {
return null;
Expand All @@ -107,7 +114,11 @@ public static PropagatedContext enterJobSubmit(
public static void exitJobSubmit(
@Advice.Argument(0) Runnable task,
@Advice.Enter PropagatedContext propagatedContext,
@Advice.Thrown Throwable throwable) {
@Advice.Thrown Throwable throwable,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
if (callDepth.decrementAndGet() > 0) {
return;
}
VirtualField<Runnable, PropagatedContext> virtualField =
VirtualField.find(Runnable.class, PropagatedContext.class);
ExecutorAdviceHelper.cleanUpAfterSubmit(propagatedContext, throwable, virtualField, task);
Expand Down Expand Up @@ -144,7 +155,13 @@ public static class SetSubmitRunnableStateAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
public static PropagatedContext enterJobSubmit(
@Advice.Argument(value = 0, readOnly = false) Runnable task) {
@Advice.This Object executor,
@Advice.Argument(value = 0, readOnly = false) Runnable task,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
callDepth = CallDepth.forClass(executor.getClass());
if (callDepth.getAndIncrement() > 0) {
return null;
}
Context context = Java8BytecodeBridge.currentContext();
if (ExecutorAdviceHelper.shouldPropagateContext(context, task)) {
VirtualField<Runnable, PropagatedContext> virtualField =
Expand All @@ -159,7 +176,11 @@ public static void exitJobSubmit(
@Advice.Argument(0) Runnable task,
@Advice.Enter PropagatedContext propagatedContext,
@Advice.Thrown Throwable throwable,
@Advice.Return Future<?> future) {
@Advice.Return Future<?> future,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
if (callDepth.decrementAndGet() > 0) {
return;
}
if (propagatedContext != null && future != null) {
VirtualField<Future<?>, PropagatedContext> virtualField =
VirtualField.find(Future.class, PropagatedContext.class);
Expand All @@ -175,7 +196,14 @@ public static void exitJobSubmit(
public static class SetCallableStateAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
public static PropagatedContext enterJobSubmit(@Advice.Argument(0) Callable<?> task) {
public static PropagatedContext enterJobSubmit(
@Advice.This Object executor,
@Advice.Argument(0) Callable<?> task,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
callDepth = CallDepth.forClass(executor.getClass());
if (callDepth.getAndIncrement() > 0) {
return null;
}
Context context = Java8BytecodeBridge.currentContext();
if (ExecutorAdviceHelper.shouldPropagateContext(context, task)) {
VirtualField<Callable<?>, PropagatedContext> virtualField =
Expand All @@ -190,7 +218,11 @@ public static void exitJobSubmit(
@Advice.Argument(0) Callable<?> task,
@Advice.Enter PropagatedContext propagatedContext,
@Advice.Thrown Throwable throwable,
@Advice.Return Future<?> future) {
@Advice.Return Future<?> future,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
if (callDepth.decrementAndGet() > 0) {
return;
}
if (propagatedContext != null && future != null) {
VirtualField<Future<?>, PropagatedContext> virtualField =
VirtualField.find(Future.class, PropagatedContext.class);
Expand All @@ -207,11 +239,18 @@ public static class SetCallableStateForCallableCollectionAdvice {

@Advice.OnMethodEnter(suppress = Throwable.class)
public static Collection<?> submitEnter(
@Advice.Argument(0) Collection<? extends Callable<?>> tasks) {
@Advice.This Object executor,
@Advice.Argument(0) Collection<? extends Callable<?>> tasks,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
if (tasks == null) {
return Collections.emptyList();
}

callDepth = CallDepth.forClass(executor.getClass());
if (callDepth.getAndIncrement() > 0) {
return Collections.emptyList();
}

Context context = Java8BytecodeBridge.currentContext();
for (Callable<?> task : tasks) {
if (ExecutorAdviceHelper.shouldPropagateContext(context, task)) {
Expand All @@ -228,7 +267,13 @@ public static Collection<?> submitEnter(

@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void submitExit(
@Advice.Enter Collection<? extends Callable<?>> tasks, @Advice.Thrown Throwable throwable) {
@Advice.Enter Collection<? extends Callable<?>> tasks,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelCallDepth") CallDepth callDepth) {
if (callDepth.decrementAndGet() > 0) {
return;
}

/*
Note1: invokeAny doesn't return any futures so all we need to do for it
is to make sure we close all scopes in case of an exception.
Expand Down