Sentry: ignore logging known exceptions #8919
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agjohnson
approved these changes
Feb 14, 2022
| # ``SENTRY_CELERY_IGNORE_EXPECTED=True``. | ||
| # | ||
| # All exceptions generated by a user miss-configuration should be listed | ||
| # here. Actually, every subclass of ``BuildUserError``. |
There was a problem hiding this comment.
Is this future proof too? Like, any subclasses of BuildUserError are already included here with the superclass in the throws list?
There was a problem hiding this comment.
This is 100% clear to me. Sentry docs does not specify if indicating the superclass is enough to avoid sending their subclasses as an error as well. So, I'm specifying all of them for now.
There was a problem hiding this comment.
Also, not sure if there is a good way to test it. However, we want all BuildUserError to not be reported to Sentry because we know it's not our fault. The "problem" is that we need to specify all the classes here, which may be a little tedious, but that's fine, I guess.
By reading https://docs.sentry.io/clients/python/integrations/#additional-settings it seems that we should be able to ignore known exceptions to be sent to Sentry. Note that we have this setting already defined at https://github.com/readthedocs/readthedocs.org/blob/b5908b0fc65cb02fc840b23eeb4218b3115b6590/readthedocs/settings/base.py#L453 However, we need to add these known exceptions to https://github.com/readthedocs/readthedocs.org/blob/b5908b0fc65cb02fc840b23eeb4218b3115b6590/readthedocs/projects/tasks/builds.py#L224-L229 This commit adds the known exceptions to be ignored by Celery and not sent to Sentry either.
humitos
force-pushed
the
humitos/sentry-ignore-known-exceptions
branch
from
e9c5829 to
00ea990
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By reading
https://docs.sentry.io/clients/python/integrations/#additional-settings it seems
that we should be able to ignore known exceptions to be sent to Sentry. Note
that we have this setting already defined at
readthedocs.org/readthedocs/settings/base.py
Line 453 in b5908b0
However, we need to add these known exceptions to
readthedocs.org/readthedocs/projects/tasks/builds.py
Lines 224 to 229 in b5908b0
This commit adds the known exceptions to be ignored by Celery and not sent to
Sentry either.
Closes #8902