Skip to content

Python docs for the openai-agents integration #14113

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

Merged
merged 4 commits into from
Jun 24, 2025

Conversation

antonpirker
Copy link
Member

@antonpirker antonpirker commented Jun 23, 2025

DESCRIBE YOUR PR

Documentation on how to use the AI Agents integration for the openai-agents package.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.): GA date: 2025-6-26
  • 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

Copy link

vercel bot commented Jun 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 24, 2025 2:34pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jun 24, 2025 2:34pm

Copy link

codecov bot commented Jun 23, 2025

Bundle Report

Changes will increase total bundle size by 204 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.92MB 210 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.8MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.64MB -0.0%
../instrumentation.js -3 bytes 973.36kB -0.0%
9523.js -3 bytes 949.31kB -0.0%
../app/[[...path]]/page.js.nft.json 73 bytes 401.64kB 0.02%
../app/platform-redirect/page.js.nft.json 73 bytes 401.55kB 0.02%
../app/sitemap.xml/route.js.nft.json 73 bytes 399.52kB 0.02%
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 873.24kB -0.0%
static/chunks/7750-*.js -3 bytes 415.85kB -0.0%
static/4sDgfZGNa7OjAp5yDq0IK/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/4sDgfZGNa7OjAp5yDq0IK/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/Y_DYV4cS2HY_miCDteWcZ/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/Y_DYV4cS2HY_miCDteWcZ/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Copy link
Contributor

@sentrivana sentrivana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, see small formatting suggestion

antonpirker added a commit to getsentry/sentry-python that referenced this pull request Jun 24, 2025
Add support for AI agents projects using `openai-agents`
(https://pypi.org/project/openai-agents/)

Docs PR is here: getsentry/sentry-docs#14113

This integration:
- records tracing data of agent invocation, tool execution, ai client
requests to LLMs, and handoffs to other agents.
- captures input and output to/from LLMs if `set_default_pii=True`.
- is mostly compatible to the OpenTelememetry `gen_ai` semantic
conventions. (input and output is not compatible because Sentry does not
have Span events. This information is stored in arrays on the Span
attributes.
- Captures errors that happen during agent execution (like problems
during interaction with the LLM.

This integration does not:
- Capture errors during function tool exection because this is very hard
to patch (see comment in the code)

Example span tree in Sentry.io:
![Screenshot 2025-06-24 at 12 15
17](https://github.com/user-attachments/assets/87199067-434f-4bb9-b563-5c6fc18c56cb)

---------

Co-authored-by: Ivana Kellyer <[email protected]>
@antonpirker antonpirker enabled auto-merge (squash) June 24, 2025 14:22
@antonpirker antonpirker merged commit ffadd7d into master Jun 24, 2025
12 checks passed
@antonpirker antonpirker deleted the antonpirker/python-openai-agents-integration branch June 24, 2025 14:34
bitsandfoxes pushed a commit that referenced this pull request Jul 3, 2025
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->

## DESCRIBE YOUR PR
Documentation on how to use the AI Agents integration for the
`openai-agents` package.

## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [x] Urgent deadline (GA date, etc.): GA date: 2025-6-26
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] 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:*

- [x] Checked Vercel preview for correctness, including links
- [x] 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](https://github.com/orgs/getsentry/teams/docs)

## LEGAL BOILERPLATE

<!-- Sentry employees and contractors can delete or ignore this section.
-->

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

- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)

---------

Co-authored-by: Ivana Kellyer <[email protected]>
@github-actions github-actions bot locked and limited conversation to collaborators Jul 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants