Skip to content

Conversation

vgrozdanic
Copy link
Member

DESCRIBE YOUR PR

This PR updates the documentation for the OpenAIAgentsIntegration to reflect that it is automatically registered when the agents package is detected.

The documentation examples have been simplified to remove explicit OpenAIAgentsIntegration() setup from sentry_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?

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

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

Open in Cursor Open in Web

Co-authored-by: vjeran.grozdanic <vjeran.grozdanic@sentry.io>
Copy link

cursor bot commented Aug 26, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

Copy link

vercel bot commented Aug 26, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Aug 26, 2025 11:44am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Aug 26, 2025 11:44am

@codeowner-assignment codeowner-assignment bot requested a review from a team August 26, 2025 11:25
@vgrozdanic vgrozdanic changed the title Remove explicit openai agents integration registration chore(docs): Remove explicit openai agents integration registration Aug 26, 2025
@vgrozdanic vgrozdanic marked this pull request as ready for review August 26, 2025 11:28
@vgrozdanic vgrozdanic requested review from antonpirker, RulaKhaled and a team August 26, 2025 11:28
Copy link

codecov bot commented Aug 26, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.9MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.48MB -9 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/oAZkKGzb_iOqiwJIHmJlr/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/oAZkKGzb_iOqiwJIHmJlr/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/duPpACoAnq_u-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/duPpACoAnq_u-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%

Comment on lines +33 to 34
If you have the `agents` package in your dependencies, the OpenAI Agents integration will be enabled automatically when you initialize the Sentry SDK.

Copy link
Contributor

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 via OpenAIAgentsIntegration(), 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's integrations list to enable it.
    severity: 0.65, confidence: 0.95

Did we get this right? 👍 / 👎 to inform future reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants