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

feat: Add optional keep_alive #2842

Merged
merged 16 commits into from
Mar 20, 2024
Merged

feat: Add optional keep_alive #2842

merged 16 commits into from
Mar 20, 2024

Conversation

sentrivana
Copy link
Contributor

@sentrivana sentrivana commented Mar 18, 2024

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_options option 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 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.

@sentrivana sentrivana marked this pull request as ready for review March 19, 2024 12:08
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a question.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldnt it be nice that people can set keep_alive=True but then also override some values in socket_options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added here: 19534de

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),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The missing TCP_KEEPIDLE probably breaks CI (because is linux)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably also in other tests missing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, fixed now

@sentrivana sentrivana enabled auto-merge (squash) March 19, 2024 15:07
Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add an option to enable keepalive
2 participants