-
Notifications
You must be signed in to change notification settings - Fork 213
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
Add Sentry ASGI middleware #3357
Conversation
Hopefully this stops the memory leak getsentry/sentry-python#419
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.
This makes sense according to the linked issue, and I appreciate the additional comments. 🤞
# Give the base application a unique name so that it's easily referenced | ||
# by other modules without needing to juggle through any of the various | ||
# middlewares. | ||
# For example, `ASGIStaticFileHandler` saves the application as | ||
# `self.application`. However, `SentryAsgiMiddleware` saves it as `self.app`. | ||
# If we relied on just referencing the pseudo-standard `application` exported | ||
# in this module, we'd have to choose how to resolve the base application | ||
# with the lifecycle handlers depending on what middleware was applied. | ||
# Instead, we can just take advantage of the fact that these middleware | ||
# all treat the passed-in application object as a singleton, so we're safe | ||
# to directly reference `OPENVERSE_APPLICATION`, knowing that any middleware | ||
# applied to it will be referencing the same application object in the end. | ||
OPENVERSE_APPLICATION = get_asgi_application() |
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.
This is in anticipation of #3024, which is the primary reason we need the lifecycle callbacks.
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.
Tested locally, works well!
After reading more into the Sentry Django integration, this change isn't necessary and cannot be the root cause of the memory leak. The Django integration already applies the ASGI middleware to the running application: https://github.com/getsentry/sentry-python/blob/44b0244156e1f332a8f173f337713dab99462609/sentry_sdk/integrations/django/asgi.py#L62 I've verified that the patch is working locally. |
Hopefully this stops the memory leak getsentry/sentry-python#419
Fixes
Related to #3353.
Description
Not sure, but the memory leak could be Sentry not having the ASGI integration enabled. This PR enables it. See the linked Sentry GitHub issue for details.
Testing Instructions
Set
SENTRY_DSN
locally and turn offDJANGO_DEBUG_ENABLED
. Cause an exception, and see that it shows up in Sentry.You can see the test events I sent here: https://openverse.sentry.io/issues/?environment=local&project=6107216&query=&referrer=issue-list&statsPeriod=14d
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin