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

Add Sentry ASGI middleware #3357

Closed
wants to merge 1 commit into from
Closed

Add Sentry ASGI middleware #3357

wants to merge 1 commit into from

Conversation

sarayourfriend
Copy link
Collaborator

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 off DJANGO_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

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Hopefully this stops the memory leak getsentry/sentry-python#419
@sarayourfriend sarayourfriend added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels Nov 15, 2023
@sarayourfriend sarayourfriend requested a review from a team as a code owner November 15, 2023 00:32
Copy link
Collaborator

@stacimc stacimc left a 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. 🤞

Comment on lines +20 to +32
# 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()
Copy link
Collaborator Author

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.

Copy link
Collaborator

@AetherUnbound AetherUnbound left a 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!

@sarayourfriend
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants