diff --git a/docs/platforms/godot/configuration/options.mdx b/docs/platforms/godot/configuration/options.mdx index 89686402f81cb5..a41ed1640afde6 100644 --- a/docs/platforms/godot/configuration/options.mdx +++ b/docs/platforms/godot/configuration/options.mdx @@ -96,6 +96,12 @@ 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. + + + ## Error Logger Options diff --git a/docs/platforms/godot/data-management/data-collected.mdx b/docs/platforms/godot/data-management/data-collected.mdx new file mode 100644 index 00000000000000..f358c49cf723a5 --- /dev/null +++ b/docs/platforms/godot/data-management/data-collected.mdx @@ -0,0 +1,42 @@ +--- +title: Data Collected +description: "See what data is collected by the Sentry SDK." +sidebar_order: 1 +--- + +Sentry takes data privacy very seriously and has default settings in place that prioritize data safety, especially when it comes to personally identifiable information (PII) data. When you add the Sentry SDK to your application, you allow it to collect data and send it to Sentry during the runtime of your application. + +The category types and amount of data collected vary, depending on the integrations you've enabled in the Sentry SDK. Here's a list of data categories the Sentry Native SDK collects: + +## User Information + +By default, the Sentry SDK doesn't send any information about users, such as email address, user ID, or username. However, if the `send_default_pii` option is enabled, Sentry backend services will infer the user's IP address based on the incoming request. + +You can also set user information from code: + +```GDScript +var user := SentryUser.new() +user.id = "custom_id" +user.email = "bob@example.com" +user.username = "bob" +user.ip_address = "127.0.0.1" +SentrySDK.set_user(user) +``` + +## Device Information + +The Sentry SDK collects information about the device, such as the name, version and build of your operating system or Linux distribution. This information is sent to Sentry by default. + +## Screenshots + +The screenshot feature is disabled by default. If you choose to enable this feature in options, any screenshots captured may contain sensitive data visible in the application at the time of the error. + +## Godot Log File + +By default, the Sentry SDK automatically attaches the Godot log file to events it sends. Since this log file contains all messages printed in your code and by the engine itself, it may inadvertently include sensitive information. To enhance privacy protection, you can disable the `attach_log` option in the Godot Project Settings. + +## Thread Stack Information + +At the time of a crash, the stack of each thread is collected and sent to Sentry as part of the Minidump snapshot for `crashpad` backend. This information is sent to Sentry by default, but dropped after processing the event in the backend. + +These files are not stored by default, but you can enable Minidump Storage in the Sentry organization or project settings. diff --git a/docs/platforms/godot/data-management/store-minidumps-as-attachments/index.mdx b/docs/platforms/godot/data-management/store-minidumps-as-attachments/index.mdx new file mode 100644 index 00000000000000..334609ded3d4b4 --- /dev/null +++ b/docs/platforms/godot/data-management/store-minidumps-as-attachments/index.mdx @@ -0,0 +1,9 @@ +--- +title: "Store Minidumps As Attachments" +description: "Learn how to enable storing minidumps as attachments in issue details." +sidebar_order: 90 +--- + + + + diff --git a/docs/platforms/godot/enriching-events/screenshots/img/project-settings.png b/docs/platforms/godot/enriching-events/screenshots/img/project-settings.png new file mode 100644 index 00000000000000..5b994f2903a3d2 Binary files /dev/null and b/docs/platforms/godot/enriching-events/screenshots/img/project-settings.png differ diff --git a/docs/platforms/godot/enriching-events/screenshots/img/screenshot-list-example.png b/docs/platforms/godot/enriching-events/screenshots/img/screenshot-list-example.png new file mode 100644 index 00000000000000..a5280e22e87e6d Binary files /dev/null and b/docs/platforms/godot/enriching-events/screenshots/img/screenshot-list-example.png differ diff --git a/docs/platforms/godot/enriching-events/screenshots/img/screenshot-thumbnail.png b/docs/platforms/godot/enriching-events/screenshots/img/screenshot-thumbnail.png new file mode 100644 index 00000000000000..18e9167fec11ae Binary files /dev/null and b/docs/platforms/godot/enriching-events/screenshots/img/screenshot-thumbnail.png differ diff --git a/docs/platforms/godot/enriching-events/screenshots/index.mdx b/docs/platforms/godot/enriching-events/screenshots/index.mdx new file mode 100644 index 00000000000000..e9ec5107836c98 --- /dev/null +++ b/docs/platforms/godot/enriching-events/screenshots/index.mdx @@ -0,0 +1,33 @@ +--- +title: "Screenshots" +description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +--- + +Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. + +This feature is only available for SDKs with a user interface, like the ones for mobile and desktop applications. It's also limited by whether taking a screenshot is possible or not. For example, in some environments, like native iOS, taking a screenshot requires the UI thread, which often isn't available in the event of a crash. Another example where a screenshot might not be available is when the event happens before the screen starts to load. So inherently, this feature is a best effort solution. + +## Enabling Screenshots + +Because screenshots may contain PII, they are an opt-in feature. To attach screenshots to your events, navigate to **Project Settings > Sentry > Options** and enable the **Attach Screenshot** option: + +![Enabling Screenshots in Project Settings](./img/project-settings.png) + +Or, like so, if you're configuring things programatically: + +```GDScript +extends SentryConfiguration + +func _configure(options: SentryOptions): + options.attach_screenshot = true +``` + +## Viewing Screenshots + +If one is available, you'll see a thumbnail of the screenshot when you click on a specific issue from the [**Issues**](https://demo.sentry.io/issues/) page. + +![Screenshot Thumbnail](./img/screenshot-thumbnail.png) + +You can see an overview of all the screenshots for the issue as well as associated events by pressing the "View All" button. + +![Screenshots List Example](./img/screenshot-list-example.png)