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

Create Event class/type #2357

Closed
antonpirker opened this issue Sep 7, 2023 · 7 comments · Fixed by #2753
Closed

Create Event class/type #2357

antonpirker opened this issue Sep 7, 2023 · 7 comments · Fixed by #2753
Assignees
Labels
Enhancement New feature or request

Comments

@antonpirker
Copy link
Member

RIght now our Event type is only a dict: https://github.com/getsentry/sentry-python/blob/antonpirker/2345-new-performance-api/sentry_sdk/_types.py#L26

We should have an Event class, that makes it easier to pass events around. (and find where events are used in the code)

@antonpirker antonpirker added the Enhancement New feature or request label Sep 7, 2023
@antonpirker antonpirker added this to the Sentry SDK 2.0 milestone Sep 7, 2023
@allanlewis
Copy link

Perhaps a TypedDict would suffice, rather than a custom class?

@antonpirker
Copy link
Member Author

Maybe, we will check.

@sentrivana
Copy link
Contributor

Hey @allanlewis -- TypedDict would be great for this, but it was only added in 3.8, and the SDK still needs to support Python versions below that (also in the new major release we're currently working on).

@allanlewis
Copy link

Hey @allanlewis -- TypedDict would be great for this, but it was only added in 3.8, and the SDK still needs to support Python versions below that (also in the new major release we're currently working on).

Versions before 3.8 are EOL 😕

@sentrivana
Copy link
Contributor

Versions before 3.8 are EOL 😕

We still want to support them though. :)

@szokeasaurusrex
Copy link
Member

We should be able to use TypedDict – as long people are using at least 3.8 in their development environment, they would be able to get proper type hints. On older Python versions, we can continue to type Event as a dict[str, Any]

@sentrivana sentrivana removed this from the Sentry SDK 2.0 milestone Feb 15, 2024
@szokeasaurusrex
Copy link
Member

Following discussion with @sentrivana and @antonpirker, all items in the TypedDict should be optional, even if they are required in the event payload sent to Sentry, because we pass around a lot of under-construction events that will not have all of these items in the code

szokeasaurusrex added a commit that referenced this issue Mar 12, 2024
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
szokeasaurusrex added a commit that referenced this issue 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants