Skip to content

fix(openai-agents): capture response.instructions as system prompt on generation spans #3739

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

Closed
ritiztambi wants to merge 1 commit into from
Closed

fix(openai-agents): capture response.instructions as system prompt on generation spans #3739

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 21 additions & 3 deletions ...metry-instrumentation-openai-agents/opentelemetry/instrumentation/openai_agents/_hooks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,19 @@ def _extract_response_attributes(otel_span, response, trace_content: bool):
return model_settings


def _prepend_system_instruction(input_data, response, trace_content: bool):
"""Prepend response.instructions as a system message to input data if available."""
if not (
trace_content
and response
and hasattr(response, "instructions")
and response.instructions
):
return input_data
system_msg = {"role": "system", "content": response.instructions}
return [system_msg] + (input_data if input_data else [])


class OpenTelemetryTracingProcessor(TracingProcessor):
"""
A tracing processor that creates OpenTelemetry spans for OpenAI Agents.
Expand Down Expand Up @@ -622,10 +635,13 @@ def on_span_end(self, span):
):
# Extract prompt data from input
input_data = getattr(span_data, "input", [])
_extract_prompt_attributes(otel_span, input_data, trace_content)

# Add function/tool specifications to the request using OpenAI semantic conventions
# Prepend system instructions from the response if available
# (the vanilla openai instrumentor already does this in responses_wrappers.py)
response = getattr(span_data, "response", None)
input_data = _prepend_system_instruction(input_data, response, trace_content)

_extract_prompt_attributes(otel_span, input_data, trace_content)
if (
response
and hasattr(response, "tools")
Expand Down Expand Up @@ -672,9 +688,11 @@ def on_span_end(self, span):
# Legacy fallback for other span types
elif span_data:
input_data = getattr(span_data, "input", [])
_extract_prompt_attributes(otel_span, input_data, trace_content)

response = getattr(span_data, "response", None)
input_data = _prepend_system_instruction(input_data, response, trace_content)

_extract_prompt_attributes(otel_span, input_data, trace_content)
if response:
model_settings = _extract_response_attributes(otel_span, response, trace_content)
self._last_model_settings = model_settings
Expand Down