@@ -79,14 +79,17 @@ from the operating system or runtime APIs, as well as mechanism-specific values.
7979
8080` synthetic `
8181
82- : An optional flag indicating that this error is synthetic. Synthetic errors
83- are errors that carry little meaning by themselves. This may be because they
84- are created at a central place (like a crash handler), and are all
85- called the same: ` Error ` , ` Segfault ` etc. When the flag is set, Sentry will then
86- try to use other information (top in-app frame function) rather than exception
87- type and value in the UI for the primary event display. This flag should be set
88- for all "segfaults" for instance as every single error group would look very
89- similar otherwise.
82+ : An optional flag indicating that this error is synthetic. Synthetic errors are errors that
83+ carry little meaning by themselves. This may be because they are created at a central
84+ place (like a crash handler), and are all called the same: ` Error ` , ` Segfault ` etc.
85+ When the flag is set, Sentry will then try to use other information (top in-app frame
86+ function) rather than the exception type and value in the UI for the primary event display.
87+ Furthermore, if this flag is set, Sentry will ignore the exception ` type ` when grouping the
88+ exception into issues.
89+ : This flag should be set for all "segfaults" for instance as every single error group would
90+ look very similar otherwise. Also, errors the SDK creates to add a stack trace to events
91+ that don't have one themselves should be marked as ` synthetic ` . For example, when users
92+ set ` attachStackTrace: true ` and capture a string message via ` captureException ` or ` captureMessage ` .
9093
9194` exception_id `
9295
@@ -118,9 +121,10 @@ mechanism (see [meta information](#meta-information)).
118121this mechanism.
119122
120123<Alert title = " Note" level = " warning" >
121- The <code >type</code > attribute is required to send any exception mechanism attribute, even
122- if the SDK cannot determine the specific mechanism. In this case, set the <code >type</code >
123- to <code >generic</code >. See below for an example.
124+ The <code >type</code > attribute is required to send any exception mechanism
125+ attribute, even if the SDK cannot determine the specific mechanism. In this
126+ case, set the <code >type</code >
127+ to <code >generic</code >. See below for an example.
124128</Alert >
125129
126130### Meta information
@@ -371,4 +375,5 @@ Exception group:
371375 ]
372376}
373377```
378+
374379`;
0 commit comments