Skip to content

Fix Span leak in APMTracer #137865

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
mosche merged 4 commits into from
Nov 13, 2025
Merged

Fix Span leak in APMTracer #137865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87923b2
Task may be unregistered outside of the trace context in exceptional …
mosche Nov 11, 2025
6625d40
Merge branch 'main' into metrics/fixApmTracerSpanLeak
mosche Nov 11, 2025
7594aed
Merge branch 'main' into metrics/fixApmTracerSpanLeak
mosche Nov 12, 2025
0eb1f85
Merge branch 'main' into metrics/fixApmTracerSpanLeak
mosche Nov 13, 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: 1 addition & 7 deletions server/src/main/java/org/elasticsearch/tasks/TaskManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,12 +191,6 @@ void maybeStartTrace(ThreadContext threadContext, Task task) {
tracer.startTrace(threadContext, task, task.getAction(), attributes);
}

void maybeStopTrace(ThreadContext threadContext, Task task) {
if (threadContext.hasTraceContext()) {
tracer.stopTrace(task);
}
}

public <Request extends ActionRequest, Response extends ActionResponse> Task registerAndExecute(
String type,
TransportAction<Request, Response> action,
Expand Down Expand Up @@ -358,7 +352,7 @@ public Task unregister(Task task) {
return removedTask;
}
} finally {
maybeStopTrace(threadPool.getThreadContext(), task);
tracer.stopTrace(task); // stop trace if started / known by tracer
for (RemovedTaskListener listener : removedTaskListeners) {
listener.onRemoved(task);
}
Expand Down
11 changes: 9 additions & 2 deletions server/src/test/java/org/elasticsearch/tasks/TaskManagerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;

public class TaskManagerTests extends ESTestCase {
Expand Down Expand Up @@ -311,6 +312,9 @@ public TaskId getParentTask() {
? Map.of(Tracer.AttributeKeys.TASK_ID, task.getId(), Tracer.AttributeKeys.PARENT_TASK_ID, parentTask.toString())
: Map.of(Tracer.AttributeKeys.TASK_ID, task.getId());
verify(mockTracer).startTrace(any(), eq(task), eq("testAction"), eq(attributes));

taskManager.unregister(task);
verify(mockTracer).stopTrace(task); // always attempt stopping to guard against leaks
}
}

Expand Down Expand Up @@ -393,7 +397,8 @@ public TaskId getParentTask() {
// no trace context

taskManager.unregister(task);
verifyNoInteractions(mockTracer);
verify(mockTracer).stopTrace(task); // always attempt stopping to guard against leaks
verifyNoMoreInteractions(mockTracer);
}

/**
Expand Down Expand Up @@ -438,6 +443,7 @@ public TaskId getParentTask() {
);

verify(mockTracer).startTrace(any(), eq(task), eq("actionName"), anyMap());
verify(mockTracer).stopTrace(task); // always attempt stopping to guard against leaks
}

/**
Expand Down Expand Up @@ -480,7 +486,8 @@ public TaskId getParentTask() {
ActionTestUtils.assertNoFailureListener(r -> {})
);

verifyNoInteractions(mockTracer);
verify(mockTracer).stopTrace(task); // always attempt stopping to guard against leaks
verifyNoMoreInteractions(mockTracer);
}

public void testRegisterWithEnabledDisabledTracing() {
Expand Down