Skip to content

fix(openai-agents): set gen_ai.operation.name to "responses" for OpenAIResponsesModel #6603

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
singlaamitesh wants to merge 2 commits into from
+63 −54
Closed

fix(openai-agents): set gen_ai.operation.name to "responses" for OpenAIResponsesModel #6603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
516fa16
fix(openai-agents): set gen_ai.operation.name to "responses" for Open…
singlaamitesh Jun 18, 2026
a5a0c2f
refactor(openai-agents): use class name mapping instead of isinstance…
singlaamitesh Jun 18, 2026
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
13 changes: 11 additions & 2 deletions sentry_sdk/integrations/openai_agents/patches/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ def _get_model(
request_model_name = model.model if hasattr(model, "model") else str(model)
agent._sentry_request_model = request_model_name

# Map model class name -> gen_ai operation name.
# This avoids importing internal model classes and is resilient to package
# restructuring while remaining explicit about every supported type.
_OPERATION_BY_MODEL_CLASS = {
"OpenAIResponsesModel": "responses",
"OpenAIChatCompletionsModel": "chat",
}
_operation = _OPERATION_BY_MODEL_CLASS.get(type(model).__name__, "chat")

# Wrap _fetch_response if it exists (for OpenAI models) to capture response model
if hasattr(model, "_fetch_response"):
original_fetch_response = model._fetch_response
Expand All @@ -112,7 +121,7 @@ async def wrapped_get_response(*args: "Any", **kwargs: "Any") -> "Any":
tool for tool in mcp_tools if isinstance(tool, HostedMCPTool)
]

with ai_client_span(agent, kwargs) as span:
with ai_client_span(agent, kwargs, operation=_operation) as span:
for hosted_tool in hosted_tools:
_inject_trace_propagation_headers(hosted_tool, span=span)

Expand Down Expand Up @@ -151,7 +160,7 @@ async def wrapped_stream_response(*args: "Any", **kwargs: "Any") -> "Any":
tool for tool in mcp_tools if isinstance(tool, HostedMCPTool)
]

with ai_client_span(agent, span_kwargs) as span:
with ai_client_span(agent, span_kwargs, operation=_operation) as span:
for hosted_tool in hosted_tools:
_inject_trace_propagation_headers(hosted_tool, span=span)

Expand Down
14 changes: 7 additions & 7 deletions sentry_sdk/integrations/openai_agents/spans/ai_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@


def ai_client_span(
agent: "Agent", get_response_kwargs: "dict[str, Any]"
agent: "Agent",
get_response_kwargs: "dict[str, Any]",
operation: str = "chat",
) -> "Union[sentry_sdk.tracing.Span, StreamedSpan]":
# TODO-anton: implement other types of operations. Now "chat" is hardcoded.
# Get model name from agent.model or fall back to request model (for when agent.model is None/default)
model_name = None
if agent.model:
Expand All @@ -33,21 +34,20 @@ def ai_client_span(
span_streaming = has_span_streaming_enabled(sentry_sdk.get_client().options)
if span_streaming:
span = sentry_sdk.traces.start_span(
name=f"chat {model_name}",
name=f"{operation} {model_name}",
attributes={
"sentry.op": OP.GEN_AI_CHAT,
"sentry.origin": SPAN_ORIGIN,
SPANDATA.GEN_AI_OPERATION_NAME: "chat",
SPANDATA.GEN_AI_OPERATION_NAME: operation,
},
)
else:
span = sentry_sdk.start_span(
op=OP.GEN_AI_CHAT,
name=f"chat {model_name}",
name=f"{operation} {model_name}",
origin=SPAN_ORIGIN,
)
# TODO-anton: remove hardcoded stuff and replace something that also works for embedding and so on
span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "chat")
span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, operation)

_set_agent_data(span, agent)
_set_input_data(span, get_response_kwargs)
Expand Down
90 changes: 45 additions & 45 deletions tests/integrations/openai_agents/test_openai_agents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,8 @@ async def test_agent_invocation_span_no_pii(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -309,8 +309,8 @@ async def test_agent_invocation_span_no_pii(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -362,8 +362,8 @@ async def test_agent_invocation_span_no_pii(
assert invoke_agent_span["data"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["data"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["description"] == "responses gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["data"]["gen_ai.system"] == "openai"
assert ai_client_span["data"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["data"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -652,8 +652,8 @@ async def test_agent_invocation_span(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -722,8 +722,8 @@ async def test_agent_invocation_span(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -788,8 +788,8 @@ async def test_agent_invocation_span(
assert invoke_agent_span["data"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["data"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["description"] == "responses gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["data"]["gen_ai.system"] == "openai"
assert ai_client_span["data"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["data"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -854,7 +854,7 @@ async def test_client_span_custom_model(
span for span in spans if span["attributes"]["sentry.op"] == OP.GEN_AI_CHAT
)

assert ai_client_span["name"] == "chat my-custom-model"
assert ai_client_span["name"] == "responses my-custom-model"
assert ai_client_span["attributes"]["gen_ai.request.model"] == "my-custom-model"
else:
with patch.object(
Expand All @@ -880,7 +880,7 @@ async def test_client_span_custom_model(
spans = transaction["spans"]
ai_client_span = next(span for span in spans if span["op"] == OP.GEN_AI_CHAT)

assert ai_client_span["description"] == "chat my-custom-model"
assert ai_client_span["description"] == "responses my-custom-model"
assert ai_client_span["data"]["gen_ai.request.model"] == "my-custom-model"


Expand Down Expand Up @@ -958,8 +958,8 @@ def test_agent_invocation_span_sync_no_pii(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -1018,8 +1018,8 @@ def test_agent_invocation_span_sync_no_pii(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -1070,8 +1070,8 @@ def test_agent_invocation_span_sync_no_pii(
assert invoke_agent_span["data"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["data"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["description"] == "responses gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["data"]["gen_ai.system"] == "openai"
assert ai_client_span["data"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["data"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -1344,8 +1344,8 @@ def test_agent_invocation_span_sync(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -1406,8 +1406,8 @@ def test_agent_invocation_span_sync(
assert invoke_agent_span["attributes"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["attributes"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["attributes"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -1466,8 +1466,8 @@ def test_agent_invocation_span_sync(
assert invoke_agent_span["data"]["gen_ai.request.temperature"] == 0.7
assert invoke_agent_span["data"]["gen_ai.request.top_p"] == 1.0

assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "chat"
assert ai_client_span["description"] == "responses gpt-4"
assert ai_client_span["data"]["gen_ai.operation.name"] == "responses"
assert ai_client_span["data"]["gen_ai.system"] == "openai"
assert ai_client_span["data"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span["data"]["gen_ai.request.max_tokens"] == 100
Expand Down Expand Up @@ -2006,8 +2006,8 @@ def simple_test_tool(message: str) -> str:
assert agent_span["attributes"]["gen_ai.request.top_p"] == 1.0
assert agent_span["attributes"]["gen_ai.system"] == "openai"

assert ai_client_span1["name"] == "chat gpt-4"
assert ai_client_span1["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span1["name"] == "responses gpt-4"
assert ai_client_span1["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span1["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span1["attributes"]["gen_ai.agent.name"] == "test_agent"

Expand Down Expand Up @@ -2080,9 +2080,9 @@ def simple_test_tool(message: str) -> str:
assert (
tool_span["attributes"]["gen_ai.tool.output"] == "Tool executed with: hello"
)
assert ai_client_span2["name"] == "chat gpt-4"
assert ai_client_span2["name"] == "responses gpt-4"
assert ai_client_span2["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span2["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span2["attributes"]["gen_ai.operation.name"] == "responses"

ai_client_span2_available_tool = json.loads(
ai_client_span2["attributes"]["gen_ai.request.available_tools"]
Expand Down Expand Up @@ -2238,8 +2238,8 @@ def simple_test_tool(message: str) -> str:
assert agent_span["attributes"]["gen_ai.request.top_p"] == 1.0
assert agent_span["attributes"]["gen_ai.system"] == "openai"

assert ai_client_span1["name"] == "chat gpt-4"
assert ai_client_span1["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span1["name"] == "responses gpt-4"
assert ai_client_span1["attributes"]["gen_ai.operation.name"] == "responses"
assert ai_client_span1["attributes"]["gen_ai.system"] == "openai"
assert ai_client_span1["attributes"]["gen_ai.agent.name"] == "test_agent"

Expand Down Expand Up @@ -2312,9 +2312,9 @@ def simple_test_tool(message: str) -> str:
assert (
tool_span["attributes"]["gen_ai.tool.output"] == "Tool executed with: hello"
)
assert ai_client_span2["name"] == "chat gpt-4"
assert ai_client_span2["name"] == "responses gpt-4"
assert ai_client_span2["attributes"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span2["attributes"]["gen_ai.operation.name"] == "chat"
assert ai_client_span2["attributes"]["gen_ai.operation.name"] == "responses"

ai_client_span2_available_tool = json.loads(
ai_client_span2["attributes"]["gen_ai.request.available_tools"]
Expand Down Expand Up @@ -2463,8 +2463,8 @@ def simple_test_tool(message: str) -> str:
assert agent_span["data"]["gen_ai.request.top_p"] == 1.0
assert agent_span["data"]["gen_ai.system"] == "openai"

assert ai_client_span1["description"] == "chat gpt-4"
assert ai_client_span1["data"]["gen_ai.operation.name"] == "chat"
assert ai_client_span1["description"] == "responses gpt-4"
assert ai_client_span1["data"]["gen_ai.operation.name"] == "responses"
assert ai_client_span1["data"]["gen_ai.system"] == "openai"
assert ai_client_span1["data"]["gen_ai.agent.name"] == "test_agent"

Expand Down Expand Up @@ -2529,9 +2529,9 @@ def simple_test_tool(message: str) -> str:
assert tool_span["data"]["gen_ai.tool.input"] == '{"message": "hello"}'
assert tool_span["data"]["gen_ai.tool.name"] == "simple_test_tool"
assert tool_span["data"]["gen_ai.tool.output"] == "Tool executed with: hello"
assert ai_client_span2["description"] == "chat gpt-4"
assert ai_client_span2["description"] == "responses gpt-4"
assert ai_client_span2["data"]["gen_ai.agent.name"] == "test_agent"
assert ai_client_span2["data"]["gen_ai.operation.name"] == "chat"
assert ai_client_span2["data"]["gen_ai.operation.name"] == "responses"

ai_client_span2_available_tool = json.loads(
ai_client_span2["data"]["gen_ai.request.available_tools"]
Expand Down Expand Up @@ -3075,7 +3075,7 @@ async def test_error_handling(
invoke_agent_span["attributes"]["sentry.origin"] == "auto.ai.openai_agents"
)

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["sentry.origin"] == "auto.ai.openai_agents"
assert ai_client_span["status"] == "error"
elif stream_gen_ai_spans:
Expand Down Expand Up @@ -3122,7 +3122,7 @@ async def test_error_handling(
invoke_agent_span["attributes"]["sentry.origin"] == "auto.ai.openai_agents"
)

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["attributes"]["sentry.origin"] == "auto.ai.openai_agents"
assert ai_client_span["status"] == "error"
else:
Expand Down Expand Up @@ -3167,7 +3167,7 @@ async def test_error_handling(
assert invoke_agent_span["description"] == "invoke_agent test_agent"
assert invoke_agent_span["origin"] == "auto.ai.openai_agents"

assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["description"] == "responses gpt-4"
assert ai_client_span["origin"] == "auto.ai.openai_agents"
assert ai_client_span["status"] == "internal_error"
assert ai_client_span["tags"]["status"] == "internal_error"
Expand Down Expand Up @@ -3238,7 +3238,7 @@ async def test_error_captures_input_data(
s for s in spans if s["attributes"].get("sentry.op", "") == "gen_ai.chat"
][0]

assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["name"] == "responses gpt-4"
assert ai_client_span["status"] == "error"

assert "gen_ai.request.messages" in ai_client_span["attributes"]
Expand Down Expand Up @@ -3282,7 +3282,7 @@ async def test_error_captures_input_data(
spans = transaction["spans"]
ai_client_span = [s for s in spans if s["op"] == "gen_ai.chat"][0]

assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["description"] == "responses gpt-4"
assert ai_client_span["status"] == "internal_error"
assert ai_client_span["tags"]["status"] == "internal_error"

Expand Down Expand Up @@ -3963,7 +3963,7 @@ async def test_ai_client_span_includes_response_model(
)

# Verify ai_client span has response model from API response
assert ai_client_span["name"] == "chat gpt-4"
assert ai_client_span["name"] == "responses gpt-4"
assert "gen_ai.response.model" in ai_client_span["attributes"]
assert (
ai_client_span["attributes"]["gen_ai.response.model"]
Expand Down Expand Up @@ -3994,7 +3994,7 @@ async def test_ai_client_span_includes_response_model(
ai_client_span = next(span for span in spans if span["op"] == OP.GEN_AI_CHAT)

# Verify ai_client span has response model from API response
assert ai_client_span["description"] == "chat gpt-4"
assert ai_client_span["description"] == "responses gpt-4"
assert "gen_ai.response.model" in ai_client_span["data"]
assert ai_client_span["data"]["gen_ai.response.model"] == "gpt-4.1-2025-04-14"

Expand Down