Skip to content

ref(develop): Clarify synthetic flag in exception mechanism #12125

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Dec 16, 2024
Merged

ref(develop): Clarify synthetic flag in exception mechanism #12125

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f7e0c0f
ref(develop): Clarify `synthetic` flag in exception mechanism
Lms24 Dec 13, 2024
060f8af
remove unrelated formatting
Lms24 Dec 13, 2024
a137f08
Update develop-docs/sdk/data-model/event-payloads/exception.mdx
Lms24 Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions develop-docs/sdk/data-model/event-payloads/exception.mdx
View file
Open in desktop
Copy link
Member Author

@Lms24 Lms24 Dec 13, 2024

Choose a reason for hiding this comment

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

excuse the awful formatting here. The : x MD syntax seems to interpret line breaks differently to conventional paragraphs which means we have to explicitly break at specific words in order to retain somewhat nice paragraph blocks on the rendered page.

Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,18 @@ from the operating system or runtime APIs, as well as mechanism-specific values.

`synthetic`

: An optional flag indicating that this error is synthetic. Synthetic errors
are errors that carry little meaning by themselves. This may be because they
are created at a central place (like a crash handler), and are all
called the same: `Error`, `Segfault` etc. When the flag is set, Sentry will then
try to use other information (top in-app frame function) rather than exception
type and value in the UI for the primary event display. This flag should be set
for all "segfaults" for instance as every single error group would look very
similar otherwise.
: An optional flag indicating that this error is synthetic. Synthetic errors are errors that
carry little meaning by themselves. This may be because they are created at a central
place (like a crash handler), and are all called the same: `Error`, `Segfault` etc.
When the flag is set, Sentry will then try to use other information (top in-app frame
function) rather than the exception type and value in the UI for the primary event display.
Furthermore, if this flag is set, Sentry will ignore the exception `type` when grouping the
exception into issues.
: This flag should be set for all "segfaults" for instance as every single error group would
look very similar otherwise. Also, errors the SDK creates to add a stack trace to events
that don't have one themselves should be marked as `synthetic` (This happens, for example,
when users set `attachStackTrace: true` and capture a string message via `captureException`
or `captureMessage`.)

`exception_id`

Expand Down
Loading