Skip to content

Agents SDK: startActivity spans should finish when the activity has been sent to the server #1172

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 6 commits into
base: main
Choose a base branch
from
+30 −41
Open

Agents SDK: startActivity spans should finish when the activity has been sent to the server #1172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d01159f
Don't set startActivity as the parent context
tconley1428 Oct 20, 2025
e1120d9
Merge branch 'main' into openai/context_detach
tconley1428 Oct 20, 2025
f7545d8
Merge branch 'main' into openai/context_detach
tconley1428 Oct 21, 2025
0a8fab6
Leave parent spans in place
tconley1428 Oct 21, 2025
1373a25
Remove prints
tconley1428 Oct 21, 2025
2b9b5da
Fix comment
tconley1428 Oct 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
56 changes: 22 additions & 34 deletions temporalio/contrib/openai_agents/_trace_interceptor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,8 +370,7 @@ class _ContextPropagationWorkflowOutboundInterceptor(
async def signal_child_workflow(
self, input: temporalio.worker.SignalChildWorkflowInput
) -> None:
trace = get_trace_provider().get_current_trace()
if trace:
if get_trace_provider().get_current_trace():
with custom_span(
name="temporal:signalChildWorkflow",
data={"workflowId": input.child_workflow_id},
Expand All @@ -385,8 +384,7 @@ async def signal_child_workflow(
async def signal_external_workflow(
self, input: temporalio.worker.SignalExternalWorkflowInput
) -> None:
trace = get_trace_provider().get_current_trace()
if trace:
if get_trace_provider().get_current_trace():
with custom_span(
name="temporal:signalExternalWorkflow",
data={"workflowId": input.workflow_id},
Expand All @@ -400,48 +398,38 @@ async def signal_external_workflow(
def start_activity(
self, input: temporalio.worker.StartActivityInput
) -> temporalio.workflow.ActivityHandle:
trace = get_trace_provider().get_current_trace()
span: Optional[Span] = None
if trace:
span = custom_span(
if get_trace_provider().get_current_trace():
with custom_span(
name="temporal:startActivity", data={"activity": input.activity}
)
span.start(mark_as_current=True)
):
set_header_from_context(input, temporalio.workflow.payload_converter())
return self.next.start_activity(input)

set_header_from_context(input, temporalio.workflow.payload_converter())
handle = self.next.start_activity(input)
if span:
handle.add_done_callback(lambda _: span.finish()) # type: ignore
return handle
return self.next.start_activity(input)

async def start_child_workflow(
self, input: temporalio.worker.StartChildWorkflowInput
) -> temporalio.workflow.ChildWorkflowHandle:
trace = get_trace_provider().get_current_trace()
span: Optional[Span] = None
if trace:
span = custom_span(
if get_trace_provider().get_current_trace():
with custom_span(
name="temporal:startChildWorkflow", data={"workflow": input.workflow}
)
span.start(mark_as_current=True)
):
set_header_from_context(input, temporalio.workflow.payload_converter())
return await self.next.start_child_workflow(input)

set_header_from_context(input, temporalio.workflow.payload_converter())
handle = await self.next.start_child_workflow(input)
if span:
handle.add_done_callback(lambda _: span.finish()) # type: ignore
return handle
return await self.next.start_child_workflow(input)

def start_local_activity(
self, input: temporalio.worker.StartLocalActivityInput
) -> temporalio.workflow.ActivityHandle:
trace = get_trace_provider().get_current_trace()
span: Optional[Span] = None
if trace:
span = custom_span(
if get_trace_provider().get_current_trace():
with custom_span(
name="temporal:startLocalActivity", data={"activity": input.activity}
)
span.start(mark_as_current=True)
):
set_header_from_context(input, temporalio.workflow.payload_converter())
return self.next.start_local_activity(input)

set_header_from_context(input, temporalio.workflow.payload_converter())
handle = self.next.start_local_activity(input)
if span:
handle.add_done_callback(lambda _: span.finish()) # type: ignore
return handle
return self.next.start_local_activity(input)
15 changes: 8 additions & 7 deletions tests/contrib/openai_agents/test_openai_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,16 @@ def paired_span(a: tuple[Span[Any], bool], b: tuple[Span[Any], bool]) -> None:
paired_span(processor.span_events[0], processor.span_events[5])
assert processor.span_events[0][0].span_data.export().get("name") == "PlannerAgent"

paired_span(processor.span_events[1], processor.span_events[4])
# startActivity happens before executeActivity
paired_span(processor.span_events[1], processor.span_events[2])
assert (
processor.span_events[1][0].span_data.export().get("name")
== "temporal:startActivity"
)

paired_span(processor.span_events[2], processor.span_events[3])
paired_span(processor.span_events[3], processor.span_events[4])
assert (
processor.span_events[2][0].span_data.export().get("name")
processor.span_events[3][0].span_data.export().get("name")
== "temporal:executeActivity"
)

Expand All @@ -113,7 +114,7 @@ def paired_span(a: tuple[Span[Any], bool], b: tuple[Span[Any], bool]) -> None:
len(parents) == 2 and parents[0].span_data.export()["type"] == "agent"
)

# Execute is parented to start
# Execute is parented to the start activity span
if span_data.get("name") == "temporal:executeActivity":
parents = [
s for (s, _) in processor.span_events if s.span_id == span.parent_id
Expand All @@ -127,14 +128,14 @@ def paired_span(a: tuple[Span[Any], bool], b: tuple[Span[Any], bool]) -> None:
paired_span(processor.span_events[-6], processor.span_events[-1])
assert processor.span_events[-6][0].span_data.export().get("name") == "WriterAgent"

paired_span(processor.span_events[-5], processor.span_events[-2])
paired_span(processor.span_events[-5], processor.span_events[-4])
assert (
processor.span_events[-5][0].span_data.export().get("name")
== "temporal:startActivity"
)

paired_span(processor.span_events[-4], processor.span_events[-3])
paired_span(processor.span_events[-3], processor.span_events[-2])
assert (
processor.span_events[-4][0].span_data.export().get("name")
processor.span_events[-3][0].span_data.export().get("name")
== "temporal:executeActivity"
)
Loading