feat: Add optional keep_alive
#2842
Merged
Conversation
This file contains 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
antonpirker
reviewed
Mar 19, 2024
sentry_sdk/transport.py
Outdated
Comment on lines
465
to
468
| if self.options["socket_options"]: | ||
| options["socket_options"] = self.options["socket_options"] | ||
| elif self.options["keep_alive"]: | ||
| options["socket_options"] = KEEP_ALIVE_SOCKET_OPTIONS |
There was a problem hiding this comment.
Wouldnt it be nice that people can set keep_alive=True but then also override some values in socket_options?
There was a problem hiding this comment.
Added here: 19534de
antonpirker
reviewed
Mar 19, 2024
tests/test_transport.py
Outdated
| assert options["socket_options"] == [ | ||
| (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 42), | ||
| (socket.SOL_TCP, socket.TCP_KEEPINTVL, 42), | ||
| (socket.SOL_TCP, socket.TCP_KEEPCNT, 6), |
There was a problem hiding this comment.
The missing TCP_KEEPIDLE probably breaks CI (because is linux)
There was a problem hiding this comment.
probably also in other tests missing.
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.
In case folks are experiencing network issues between the SDK and Sentry, we in general recommend tweaking socket_options directly with a predefined set of settings. This seems to alleviate the issue most of the time, but feels rather low-level and hacky.
Node has a separate keepAlive transport option. We could do something similar: an option that sets the socket options to what we usually recommend, while keeping the
socket_optionsoption around as well for users who need more control over things.Docs: getsentry/sentry-docs#9498
Closes #2837
General 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 secretslabel. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.