diff --git a/docs/platforms/godot/configuration/options.mdx b/docs/platforms/godot/configuration/options.mdx index 53e5ab49493a53..c14740cc651db9 100644 --- a/docs/platforms/godot/configuration/options.mdx +++ b/docs/platforms/godot/configuration/options.mdx @@ -24,7 +24,7 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti - + 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. @@ -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. +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`. @@ -82,16 +82,18 @@ This option is disabled by default. If you enable this option, be sure to manual - + If enabled, the SDK will attach the Godot log file to the event. - + If enabled, the SDK will try to take a screenshot and attach it to the event. +This option is turned off by default. + This feature is experimental and may impact performance when capturing screenshots. We recommend testing before enabling in production. @@ -100,9 +102,9 @@ This feature is experimental and may impact performance when capturing screensho - + -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`. @@ -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 Scene Tree for more details. +This option is turned off by default. + ## GUI-only Options These options are only available in the **Project Settings** window. - + 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. + - + 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. + ## Error Logger Options - + 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. + - + -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. @@ -163,9 +173,9 @@ options.logger_breadcrumb_mask = mask - + -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`). ```GDScript var mask = SentryOptions.MASK_ERROR | SentryOptions.MASK_SCRIPT @@ -174,16 +184,20 @@ options.logger_event_mask = mask - + 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. + - + 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. + 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. +This option is turned on by default. + @@ -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`.