You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## DESCRIBE YOUR PR
Adding missing options since changing over SDKoption for all option
formatting.
Preview:
https://sentry-docs-git-godot-options-updates.sentry.dev/platforms/godot/configuration/options/
## IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
---------
Co-authored-by: Shannon Anahata <[email protected]>
Co-authored-by: Serhii Snitsaruk <[email protected]>
Turns debug mode on or off. If `debug` is enabled, the SDK will print useful debugging information. You can see it in the Output panel of the Godot editor. It's generally not recommended to turn it on in production, though turning `debug` mode on will not cause any safety concerns.
30
30
@@ -34,9 +34,9 @@ You can control the verbosity using the `diagnostic_level` option.
Specifies the minimum level of messages to be printed if `debug` is turned on.
39
+
Specifies the minimum level of messages to be printed if `debug` is turned on. Possible values are: `LEVEL_DEBUG`, `LEVEL_INFO`, `LEVEL_WARNING`, `LEVEL_ERROR`, and `LEVEL_FATAL`.
40
40
41
41
</SdkOption>
42
42
@@ -82,16 +82,18 @@ This option is disabled by default. If you enable this option, be sure to manual
Specifies the minimum level of events for which screenshots will be captured. By default, screenshots are captured for fatal events.
107
+
Specifies the minimum level of events for which screenshots will be captured. Possible values are: `LEVEL_DEBUG`, `LEVEL_INFO`, `LEVEL_WARNING`, `LEVEL_ERROR`, and `LEVEL_FATAL`.
106
108
107
109
<Alerttitle="Note">
108
110
@@ -112,42 +114,50 @@ Changing this option may impact performance in the frames the screenshots are ta
If enabled, the SDK will capture and attach scene tree information to events. The scene tree data is attached as a `view-hierarchy.json` file, and you can explore it in the "Scene Tree" section of each issue that includes this attachment. This provides valuable context about your game's scene tree at the time of the error. See <PlatformLinkto="/enriching-events/view-hierarchy/">Scene Tree</PlatformLink> for more details.
118
120
121
+
This option is turned off by default.
122
+
119
123
</SdkOption>
120
124
121
125
## GUI-only Options
122
126
123
127
These options are only available in the **Project Settings** window.
If `true`, the SDK will capture logged errors as events and/or breadcrumbs, as defined by `logger_event_mask` and `logger_breadcrumb_mask` options. Crashes are always captured.
Specifies the types of errors captured as breadcrumbs. Accepts a single value or a bitwise combination of `GodotErrorMask` masks.
160
+
Specifies the types of errors captured as breadcrumbs. Accepts a single value or a bitwise combination of `GodotErrorMask` masks. The default value captures nativer errors, warnings, script and shader errors (`MASK_ERROR | MASK_WARNING | MASK_SCRIPT | MASK_SHADER`).
Specifies the types of errors captured as events. Accepts a single value or a bitwise combination of `GodotErrorMask` masks.
178
+
Specifies the types of errors captured as events. Accepts a single value or a bitwise combination of `GodotErrorMask` masks. The default value captures native, script and shader errors (`MASK_ERROR | MASK_SCRIPT` | `MASK_SHADER`).
169
179
170
180
```GDScript
171
181
var mask = SentryOptions.MASK_ERROR | SentryOptions.MASK_SCRIPT
If `true`, the SDK will include local variables from stack traces when capturing script errors. This allows showing the values of variables at each frame in the call stack. Requires enabling **Debug -> Settings -> GDScript -> Always Track Local Variables** in the **Project Settings**.
186
198
199
+
This option is turned on by default.
200
+
187
201
<Alerttitle="Note">
188
202
189
203
Enabling this option may impact performance, especially for applications with frequent errors or deep call stacks.
@@ -192,10 +206,12 @@ Enabling this option may impact performance, especially for applications with fr
If `true`, the SDK will capture log messages (such as `print()` statements) as breadcrumbs along with events.
198
212
213
+
This option is turned on by default.
214
+
199
215
</SdkOption>
200
216
201
217
<SdkOptionname="logger_limits"type="object">
@@ -204,13 +220,13 @@ Defines throttling limits for the error logger. These limits are used to prevent
204
220
205
221
This option contains multiple properties that govern the behavior of throttling. The following paragraphs explain each of those properties in detail.
206
222
207
-
`events_per_frame` specifies the maximum number of error events to send per processed frame. If exceeded, no further errors will be captured until the next frame. This serves as a safety measure to prevent the SDK from overloading a single frame.
223
+
`events_per_frame` specifies the maximum number of error events to send per processed frame. If exceeded, no further errors will be captured until the next frame. This serves as a safety measure to prevent the SDK from overloading a single frame. Default: `5`.
208
224
209
-
`repeated_error_window_ms` specifies the minimum time interval in milliseconds between two identical errors. If exceeded, no further errors from the same line of code with the identical message will be captured until the next interval. Set it to `0` to disable this limit.
225
+
`repeated_error_window_ms` specifies the minimum time interval in milliseconds between two identical errors. If exceeded, no further errors from the same line of code with the identical message will be captured until the next interval. Set it to `0` to disable this limit. Default: `1000`.
210
226
211
-
`throttle_events` specifies the maximum number of events allowed within a sliding time window of `throttle_window_ms` milliseconds. If exceeded, errors will be captured as breadcrumbs only until capacity is freed.
227
+
`throttle_events` specifies the maximum number of events allowed within a sliding time window of `throttle_window_ms` milliseconds. If exceeded, errors will be captured as breadcrumbs only until capacity is freed. Default: `10`.
212
228
213
-
`throttle_window_ms` specifies the time window in milliseconds for `throttle_events`. Set it to `0` to disable this limit.
229
+
`throttle_window_ms` specifies the time window in milliseconds for `throttle_events`. Set it to `0` to disable this limit. Default: `10000`.
0 commit comments