feat(integrations): Allow to configure status codes to report to Sentry #3008
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.
Until now, our server framework integrations used to only report status codes in the 5xx range to Sentry. The reasoning was that the client should report client side errors.
However, not everyone has the client instrumented or wants to have it instrumented, and they might want to have the client range 4xx reported to Sentry by the server integration.
Closes #2825
Failed request status codes
In this PR, we add a new option to all applicable HTTP web framework integrations called
failed_request_status_codes
(naming based on develop docs) to make it possible to configure which status codes should be reported to Sentry. If nofailed_request_status_codes
are provided, we default to the5xx
range.failed_request_status_codes
is a list of status code ranges, where a status code range is one of:__contains__
method (so that we can check whether a code is in the sequence within
)The following are examples of valid
failed_request_status_codes
:[500]
[403, range(500, 599)]
[{500, 501, 502, 503}]
WIP
Follow up
handled
tag is alwaysFalse
#2904 -- could be a function akin tobefore_send
which gets the exception and can decide on its own whether to report itGeneral 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.