Skip to content

Adding defaults for Godot options #15216

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 21 commits into from
Oct 22, 2025
Merged

Adding defaults for Godot options #15216

Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
fae94f1
adding defaults for Godot options
Oct 14, 2025
8c90a63
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
bcbfe72
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
889754c
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
efe5f9d
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
686bdd9
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
d8e6161
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
985802a
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
7e470bc
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
151267a
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
91d7401
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
fcd1569
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
b6e19fb
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
ddd60d9
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
f177f8a
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
459e1b8
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
2a91389
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
4f4680d
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
d73e236
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
f2422f7
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
c63ec87
Update docs/platforms/godot/configuration/options.mdx
sfanahata Oct 22, 2025
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
60 changes: 38 additions & 22 deletions docs/platforms/godot/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti

</SdkOption>

<SdkOption name="debug" type="bool">
<SdkOption name="debug" type="bool" defaultValue="false">

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.

Expand All @@ -34,9 +34,9 @@ You can control the verbosity using the `diagnostic_level` option.

</SdkOption>

<SdkOption name="diagnostic_level" type="enum">
<SdkOption name="diagnostic_level" type="SentrySDK.Level" defaultValue="LEVEL_DEBUG">

Specifies the minimum level of messages to be printed if `debug` is turned on.
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`.

</SdkOption>

Expand Down Expand Up @@ -82,16 +82,18 @@ This option is disabled by default. If you enable this option, be sure to manual

</SdkOption>

<SdkOption name="attach_log" type="bool">
<SdkOption name="attach_log" type="bool" defaultValue="true">

If enabled, the SDK will attach the Godot log file to the event.

</SdkOption>

<SdkOption name="attach_screenshot" type="bool">
<SdkOption name="attach_screenshot" type="bool" defaultValue="false">

If enabled, the SDK will try to take a screenshot and attach it to the event.

This option is turned off by default.

<Alert level="warning" title="Important">

This feature is experimental and may impact performance when capturing screenshots. We recommend testing before enabling in production.
Expand All @@ -100,9 +102,9 @@ This feature is experimental and may impact performance when capturing screensho

</SdkOption>

<SdkOption name="screenshot_level" type="enum">
<SdkOption name="screenshot_level" type="SentrySDK.Level" defaultValue="LEVEL_FATAL">

Specifies the minimum level of events for which screenshots will be captured. By default, screenshots are captured for fatal events.
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`.

<Alert title="Note">

Expand All @@ -112,42 +114,50 @@ Changing this option may impact performance in the frames the screenshots are ta

</SdkOption>

<SdkOption name="attach_scene_tree" type="bool">
<SdkOption name="attach_scene_tree" type="bool" defaultValue="false">

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 <PlatformLink to="/enriching-events/view-hierarchy/">Scene Tree</PlatformLink> for more details.

This option is turned off by default.

</SdkOption>

## GUI-only Options

These options are only available in the **Project Settings** window.

<SdkOption name="auto_init" type="bool">
<SdkOption name="auto_init" type="bool" defaultValue="true">

Enables automatic SDK initialization when the game starts.
The SDK initializes as early as possible in the lifecycle — before scenes are loaded or any scripts are executed.

This option is turned on by default.

</SdkOption>

<SdkOption name="skip_auto_init_on_editor_play" type="bool">
<SdkOption name="skip_auto_init_on_editor_play" type="bool" defaultValue="true">

Prevents automatic initialization when running the game from the editor
(for example, by pressing the play button or **F5**).
This setting only applies if **Auto Init** is enabled.

This option is turned on by default.

</SdkOption>

## Error Logger Options

<SdkOption name="logger_enabled" type="bool">
<SdkOption name="logger_enabled" type="bool" defaultValue="true">

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.

This option is turned on by default.

</SdkOption>

<SdkOption name="logger_breadcrumb_mask" type="int">
<SdkOption name="logger_breadcrumb_mask" type="int" defaultValue="7">

Specifies the types of errors captured as breadcrumbs. Accepts a single value or a bitwise combination of `GodotErrorMask` masks.
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`).

`GodotErrorMask` values:
- `MASK_NONE`: No logger errors will be captured.
Expand All @@ -163,9 +173,9 @@ options.logger_breadcrumb_mask = mask

</SdkOption>

<SdkOption name="logger_event_mask" type="int">
<SdkOption name="logger_event_mask" type="int" defaultValue="5">

Specifies the types of errors captured as events. Accepts a single value or a bitwise combination of `GodotErrorMask` masks.
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`).
Copy link

Choose a reason for hiding this comment

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

Bug: Logger Mask Default Value Mismatch

The logger_event_mask option's defaultValue is 5, corresponding to MASK_ERROR | MASK_SCRIPT. However, its description states that the default captures "native, script and shader errors," which would imply MASK_SHADER is also included.

Fix in Cursor Fix in Web


```GDScript
var mask = SentryOptions.MASK_ERROR | SentryOptions.MASK_SCRIPT
Expand All @@ -174,16 +184,20 @@ options.logger_event_mask = mask

</SdkOption>

<SdkOption name="logger_include_source" type="bool">
<SdkOption name="logger_include_source" type="bool" defaultValue="true">

If `true`, the SDK will include the surrounding source code of logged errors, if available in the exported project.

This option is turned on by default.

</SdkOption>

<SdkOption name="logger_include_variables" type="bool">
<SdkOption name="logger_include_variables" type="bool" defaultValue="true">

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**.

This option is turned on by default.

<Alert title="Note">

Enabling this option may impact performance, especially for applications with frequent errors or deep call stacks.
Expand All @@ -192,10 +206,12 @@ Enabling this option may impact performance, especially for applications with fr

</SdkOption>

<SdkOption name="logger_messages_as_breadcrumbs" type="bool">
<SdkOption name="logger_messages_as_breadcrumbs" type="bool" defaultValue="true">

If `true`, the SDK will capture log messages (such as `print()` statements) as breadcrumbs along with events.

This option is turned on by default.

</SdkOption>

<SdkOption name="logger_limits" type="object">
Expand All @@ -204,13 +220,13 @@ Defines throttling limits for the error logger. These limits are used to prevent

This option contains multiple properties that govern the behavior of throttling. The following paragraphs explain each of those properties in detail.

`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.
`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`.

`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.
`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`.

`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.
`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`.

`throttle_window_ms` specifies the time window in milliseconds for `throttle_events`. Set it to `0` to disable this limit.
`throttle_window_ms` specifies the time window in milliseconds for `throttle_events`. Set it to `0` to disable this limit. Default: `10000`.

</SdkOption>

Expand Down
Loading