-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
chore(docs): Remove explicit openai agents integration registration #14718
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.
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
base: master
Are you sure you want to change the base?
chore(docs): Remove explicit openai agents integration registration #14718
Conversation
Co-authored-by: vjeran.grozdanic <vjeran.grozdanic@sentry.io>
Cursor Agent can help with this pull request. Just |
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
If you have the `agents` package in your dependencies, the OpenAI Agents integration will be enabled automatically when you initialize the Sentry SDK. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Potential bug: The documentation incorrectly states the OpenAI Agents integration is auto-enabled. This will cause users to miss manual setup, resulting in no monitoring.
-
Description: The documentation at
docs/platforms/python/integrations/openai-agents/index.mdx
is being updated to claim that the OpenAI Agents integration is automatically enabled. However, this is incorrect. The main integration table in the repository does not list it as auto-enabled, and the code requires explicit registration viaOpenAIAgentsIntegration()
, as shown later in the same document. Users following this new documentation will expect automatic monitoring of their AI agents but will receive none, leading to a silent failure of the monitoring functionality in their applications. -
Suggested fix: Revert the change that claims automatic enablement. The documentation should continue to show that the
OpenAIAgentsIntegration()
must be explicitly added to the Sentry SDK'sintegrations
list to enable it.
severity: 0.65, confidence: 0.95
Did we get this right? 👍 / 👎 to inform future reviews.
DESCRIBE YOUR PR
This PR updates the documentation for the
OpenAIAgentsIntegration
to reflect that it is automatically registered when theagents
package is detected.The documentation examples have been simplified to remove explicit
OpenAIAgentsIntegration()
setup fromsentry_sdk.init()
, aligning with the goal of providing an "out-of-the-box" experience for AI observability.An "Options" section has been added, similar to other AI integrations, to explain when explicit registration is still useful (e.g., to configure options like
include_prompts
).IS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES
Slack Thread