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(native): advanced usage section to explain OS error handling #9787

Conversation

supervacuus
Copy link
Collaborator

This PR introduces a new section, "Advanced usage," which allows us to go into much more detail when describing how operating systems behave and how this affects users of the Native SDK.

This section should house topics that our users repeatedly encounter, which we cannot hide behind a nice facade and which runtime developers do not abstract away from our responsibility (as is the case for most other SDKs).

While this section will soon see additions like

The current driver for the section and content of this PR is the use of POSIX signal handling on Linux and Android and the issues users need to be aware of: getsentry/sentry-native#960.

@kahest, can I ask you for a first review of whether this level of detail makes sense? It is really hard to reduce this further without linking every other word. I tried to balance this and removed a lot of detail already. I adapted it also to the future content in expected tone and level of detail.

Copy link

vercel bot commented Apr 23, 2024

@supervacuus is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Apr 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 2, 2024 7:45am

@kahest
Copy link
Member

kahest commented Apr 23, 2024

@supervacuus thank you, this is great! IMO the LoD is perfect 💯
cc @lizokm @stephanie-anderson this is the "Advanced Usage" section and the first "article" that I kinda announced a while ago - wdyt of the menu structure, title, etc?

Co-authored-by: Karl Heinz Struggl <kahest@users.noreply.github.com>
Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

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

Did a first pass at the signal handling section and left some suggestions. Didn't have time to review the "advanced usage" page. Will take another look tomorrow!

supervacuus and others added 9 commits April 26, 2024 09:53
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
supervacuus and others added 2 commits April 27, 2024 08:02
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@supervacuus
Copy link
Collaborator Author

I adapted the text with all agreed-upon suggestions. Thanks a lot, @vivianyentran and @kahest!

Copy link
Member

@kahest kahest left a comment

Choose a reason for hiding this comment

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

Thanks for this, looks really good now 🚀

Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

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

Added a couple more wording suggestions, but this is looking great now and feels much easier to read!

supervacuus and others added 7 commits April 30, 2024 09:55
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@kahest kahest merged commit 3560c75 into getsentry:master May 2, 2024
6 checks passed
@supervacuus supervacuus deleted the feat/advanced_usage_section_for_signal_handling branch May 2, 2024 08:23
@github-actions github-actions bot locked and limited conversation to collaborators May 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[#inc-517] Document caveats of signalhandlers and sigaltstack
3 participants