Skip to content

docs(Godot): Mark screenshot option as experimental #14988

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 6 commits into from
Sep 22, 2025
Merged

docs(Godot): Mark screenshot option as experimental #14988

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
330698d
docs(Godot): Mark screenshot option as experimental
limbonaut Sep 19, 2025
c598b29
Change alert title
limbonaut Sep 19, 2025
6299c70
Fix alert
limbonaut Sep 19, 2025
39d80a8
Update Screenshots page
limbonaut Sep 19, 2025
08e401a
Apply suggestion
limbonaut Sep 19, 2025
86c9302
Softer versions
limbonaut Sep 19, 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
6 changes: 6 additions & 0 deletions docs/platforms/godot/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,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.

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

This feature is experimental and may impact performance when screenshots are captured. Not recommended for production use.
Copy link
Member

Choose a reason for hiding this comment

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

you can remove the last "not recommended for production" because I feel it's beating a dead horse

We have this under a waning box. Saying it's experimental. I feel that's enough warning already

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I replaced it with softer version. Hopefully, it doesn't make an impression of beating a dead horse now.


</Alert>

</ConfigKey>

<ConfigKey name="screenshot-level">
Expand Down
Binary file modified docs/platforms/godot/enriching-events/screenshots/img/project-settings.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs/platforms/godot/enriching-events/screenshots/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ This feature is only available for SDKs with a user interface, like the ones for

## Enabling Screenshots

Because screenshots may contain <PlatformLink to="/data-management/sensitive-data/">PII</PlatformLink>, they are an opt-in feature. To attach screenshots to your events, navigate to **Project Settings > Sentry > Options** and enable the **Attach Screenshot** option:
<Alert level="warning" title="Important">

Screenshots are currently experimental in Sentry for Godot and are not recommended for production environments. This feature is under development and will be improved in future releases.

</Alert>

Because screenshots may contain <PlatformLink to="/data-management/sensitive-data/">PII</PlatformLink>, they are an opt-in feature. To attach screenshots to your events, navigate to **Project Settings > Sentry > Experimental** and enable the **Attach Screenshot** option:

![Enabling Screenshots in Project Settings](./img/project-settings.png)

Expand Down
Loading