Skip to content
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

OpenAI integration #2791

Merged
merged 22 commits into from Mar 11, 2024
Merged

OpenAI integration #2791

merged 22 commits into from Mar 11, 2024

Conversation

colin-sentry
Copy link
Member

OpenAI integration for performance monitoring.

This commit instruments two OpenAI functions (for now) with monkeypatches, and creates span objects automatically.


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

sentry_sdk/integrations/openai.py Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
Copy link
Member

@indragiek indragiek left a comment

Choose a reason for hiding this comment

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

looks great! will defer to @Zylphrex and others for final review

sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

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

Yay! An OpenAI integration! Great work! Requested some changes to have the data in all the right places.

One important general question:

Is it possible that this will send personal data of any kind?
If yes, please guard it like we do here: https://github.com/getsentry/sentry-python/blob/master/sentry_sdk/integrations/flask.py#L186

tests/integrations/openai/test_openai.py Outdated Show resolved Hide resolved
tests/integrations/openai/test_openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

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

Wow, that was a fast update!

I took the liberty do add a small fix to make the test pass. Please pull your openai branch.

Some little changes we will still have to make, but then we are good to go!

sentry_sdk/consts.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
sentry_sdk/integrations/openai.py Outdated Show resolved Hide resolved
tests/integrations/openai/test_openai.py Show resolved Hide resolved
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

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

Yes, looks great now! Thanks for all the hard work!
You can merge this now!

@colin-sentry colin-sentry enabled auto-merge (squash) March 11, 2024 13:55
@colin-sentry colin-sentry merged commit ff0a94b into master Mar 11, 2024
122 of 124 checks passed
@colin-sentry colin-sentry deleted the openai branch March 11, 2024 14:06
szokeasaurusrex added a commit that referenced this pull request Mar 13, 2024
* ref: Improve scrub_dict typing (#2768)

This change improves the typing of the scrub_dict method.

Previously, the scrub_dict method's type hints indicated that only dict[str, Any] was accepted as the parameter. However, the method is actually implemented to accept any object, since it checks the types of the parameters at runtime. Therefore, object is a more appropriate type hint for the parameter.

#2753 depends on this change for mypy to pass

* Propagate sentry-trace and baggage to huey tasks (#2792)

This PR enables passing `sentry-trace` and `baggage` headers to background tasks using the Huey task queue.

This allows easily correlating what happens inside a background task with whatever transaction (e.g. a user request in a Django application) queued the task in the first place.

Periodic tasks do not get these headers, because otherwise each execution of the periodic task would be tied to the same parent trace (the long-running worker process).

--- 

Co-authored-by: Anton Pirker <anton.pirker@sentry.io>

* OpenAI integration (#2791)

* OpenAI integration

* Fix linting errors

* Fix CI

* Fix lint

* Fix more CI issues

* Run tests on version pinned OpenAI too

* Fix pydantic issue in test

* Import type in TYPE_CHECKING gate

* PR feedback fixes

* Fix tiktoken test variant

* PII gate the request and response

* Rename set_data tags

* Move doc location

* Add "exclude prompts" flag as optional

* Change prompts to be excluded by default

* Set flag in tests

* Fix tiktoken tox.ini extra dash

* Change strip PII semantics

* More test coverage for PII

* notiktoken

---------

Co-authored-by: Anton Pirker <anton.pirker@sentry.io>

* Add a method for normalizing data passed to set_data (#2800)

* Discard open spans after 10 minutes (#2801)

OTel spans that are handled in the Sentry span processor can never be finished/closed. This leads to a memory leak. This change makes sure that open spans will be removed from memory after 10 minutes to prevent memory usage from growing constantly.

Fixes #2722

---------

Co-authored-by: Daniel Szoke <szokeasaurusrex@users.noreply.github.com>

* ref: Event Type (#2753)

Implements type hinting for Event via a TypedDict. This commit mainly adjusts type hints; however, there are also some minor code changes to make the code type-safe following the new changes.

Some items in the Event could have their types expanded by being defined as TypedDicts themselves. These items have been indicated with TODO comments.

Fixes GH-2357

* Fix mypy in `client.py`

* Fix functools import

* Fix CI config problem

... by running `python scripts/split-tox-gh-actions/split-tox-gh-actions.py`

---------

Co-authored-by: Christian Schneider <christian@cnschn.com>
Co-authored-by: Anton Pirker <anton.pirker@sentry.io>
Co-authored-by: colin-sentry <161344340+colin-sentry@users.noreply.github.com>
colin-sentry added a commit to getsentry/relay that referenced this pull request Mar 26, 2024
Upstream in SDKs (getsentry/sentry-python#2791)
we added strings like "ai.prompt_tokens.used"

This adds them as known data fields, otherwise they are removed as PII
since most configurations consider any superstring of "token" to be a
password.
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.

None yet

4 participants