Fix OpenAI Agents SDK guardrail span classification #1096
+167
−155
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
- Add GuardrailSpanData handling to get_span_kind() function - Add get_guardrail_span_attributes() function with proper GUARDRAIL span kind - Add GUARDRAIL_SPAN_ATTRIBUTES mapping for consistent attribute extraction - Add GuardrailSpanData case to get_span_attributes() dispatcher Fixes issue where GuardrailSpanData spans were falling through to generic classification instead of being properly mapped to GUARDRAIL span type. Co-Authored-By: Alex <[email protected]>
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
Co-Authored-By: Alex <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Vibe coded but looks good? Can you test @fenilfaldu ? |
- Add test_guardrail_span_attributes() to test main functionality - Add test_guardrail_span_attributes_without_optional_fields() for edge cases - Add GuardrailSpanData test case to test_span_attributes_dispatcher() - Import get_guardrail_span_attributes in test imports Addresses codecov/patch failure by adding comprehensive test coverage for the new guardrail span handling code. Co-Authored-By: Alex <[email protected]>
Apply automatic formatting changes from ruff-format to resolve pre-commit check failure. Adds blank line after docstring. Co-Authored-By: Alex <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix OpenAI Agents SDK guardrail span classification
Problem
The OpenAI Agents SDK integration was incorrectly classifying guardrail events as generic events or agent spans instead of properly mapping them to
GUARDRAILspan types. This prevented proper observability and tracing of guardrail events in the AgentOps platform.Root Cause
Two functions in the OpenAI Agents SDK instrumentation were missing handlers for
GuardrailSpanData:get_span_kind()inexporter.py- didn't handleGuardrailSpanData, causing it to fall through to defaultSpanKind.INTERNALget_span_attributes()inattributes/common.py- didn't have a case forGuardrailSpanData, so these spans didn't get proper AgentOps span kind attributesSolution
Added proper
GuardrailSpanDatahandling following the established patterns in the codebase:Changes Made
Updated
get_span_kind()function inexporter.py:GuardrailSpanDatato theHandoffSpanDatacase forSpanKind.INTERNALAdded
GUARDRAIL_SPAN_ATTRIBUTESmapping inattributes/common.py:Added
get_guardrail_span_attributes()function inattributes/common.py:GuardrailSpanDataobjectsAGENTOPS_SPAN_KINDtoGUARDRAILvaluenameandtriggeredUpdated
get_span_attributes()dispatcher inattributes/common.py:GuardrailSpanDatacase to route to the new handler functionTesting
✅ Verified with OpenAI Agents SDK guardrail example:
examples/openai_agents/agent_guardrails.py✅ Lint checks: Pre-commit hooks passed with automatic formatting applied
Impact
GUARDRAILspansLink to Devin run
https://app.devin.ai/sessions/0764439e61a6472fa04739fd1db8fb08
Requested by: Alex ([email protected])