From f7e0c0fc574cf5bf5c180347da42c2b3c39199c5 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Fri, 13 Dec 2024 11:24:33 +0100 Subject: [PATCH 1/3] ref(develop): Clarify `synthetic` flag in exception mechanism --- .../data-model/event-payloads/exception.mdx | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/develop-docs/sdk/data-model/event-payloads/exception.mdx b/develop-docs/sdk/data-model/event-payloads/exception.mdx index 2f0d92e3a1dbe..3f4fb696016e9 100644 --- a/develop-docs/sdk/data-model/event-payloads/exception.mdx +++ b/develop-docs/sdk/data-model/event-payloads/exception.mdx @@ -79,14 +79,17 @@ 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`. For example, when users +set `attachStackTrace: true` and capture a string message via `captureException` or `captureMessage`. `exception_id` @@ -118,9 +121,10 @@ mechanism (see [meta information](#meta-information)). this mechanism. -The type attribute is required to send any exception mechanism attribute, even -if the SDK cannot determine the specific mechanism. In this case, set the type -to generic. See below for an example. + The type attribute is required to send any exception mechanism + attribute, even if the SDK cannot determine the specific mechanism. In this + case, set the type + to generic. See below for an example. ### Meta information @@ -371,4 +375,5 @@ Exception group: ] } ``` + `; From 060f8af5c14fab933fefac37e797574a5c7fc442 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Fri, 13 Dec 2024 11:27:16 +0100 Subject: [PATCH 2/3] remove unrelated formatting --- develop-docs/sdk/data-model/event-payloads/exception.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/develop-docs/sdk/data-model/event-payloads/exception.mdx b/develop-docs/sdk/data-model/event-payloads/exception.mdx index 3f4fb696016e9..9fd388327dbd2 100644 --- a/develop-docs/sdk/data-model/event-payloads/exception.mdx +++ b/develop-docs/sdk/data-model/event-payloads/exception.mdx @@ -121,10 +121,9 @@ mechanism (see [meta information](#meta-information)). this mechanism. - The type attribute is required to send any exception mechanism - attribute, even if the SDK cannot determine the specific mechanism. In this - case, set the type - to generic. See below for an example. +The type attribute is required to send any exception mechanism attribute, even +if the SDK cannot determine the specific mechanism. In this case, set the type +to generic. See below for an example. ### Meta information @@ -375,5 +374,4 @@ Exception group: ] } ``` - `; From a137f08dfdb8c2fa4bdf9948f9be1b23dccf9cf0 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Mon, 16 Dec 2024 09:24:30 +0100 Subject: [PATCH 3/3] Update develop-docs/sdk/data-model/event-payloads/exception.mdx Co-authored-by: Katie Byers --- develop-docs/sdk/data-model/event-payloads/exception.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/develop-docs/sdk/data-model/event-payloads/exception.mdx b/develop-docs/sdk/data-model/event-payloads/exception.mdx index 9fd388327dbd2..e694ddf4ab02d 100644 --- a/develop-docs/sdk/data-model/event-payloads/exception.mdx +++ b/develop-docs/sdk/data-model/event-payloads/exception.mdx @@ -88,8 +88,9 @@ Furthermore, if this flag is set, Sentry will ignore the exception `type` when g 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`. For example, when users -set `attachStackTrace: true` and capture a string message via `captureException` or `captureMessage`. +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`