-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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.
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
Add screenshot feature description for Unreal Engine #11042
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
09fa41d
Add screenshot feature description for Unreal Engine
tustanivsky 494da1b
Update screenshot
tustanivsky 5b940c2
Update docs/platforms/unreal/enriching-events/screenshots/index.mdx
tustanivsky 0dc8abf
Update platform-includes/enriching-events/attach-screenshots/unreal.mdx
tustanivsky 452a6f4
Update platform-includes/enriching-events/attach-screenshots/unreal.mdx
tustanivsky 002488c
Update platform-includes/enriching-events/attach-screenshots/unreal.mdx
tustanivsky b2384a2
Update platform-includes/enriching-events/attach-screenshots/unreal.mdx
lizokm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+12.6 KB
docs/platforms/unreal/enriching-events/screenshots/img/screenshot-list-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions
20
docs/platforms/unreal/enriching-events/screenshots/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: "Screenshots" | ||
description: "Learn more about how to set up Sentry to take screenshots when an error occurs. The screenshot will be paired with the original event, giving you additional insight into issues." | ||
--- | ||
|
||
Sentry makes it possible to automatically take a screenshot and include it as an <PlatformLink to="/enriching-events/attachments/">attachment</PlatformLink> 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 <PlatformLink to="/data-management/sensitive-data/">PII</PlatformLink>, they are an opt-in feature. You can enable screenshots as shown below: | ||
|
||
<PlatformContent includePath="enriching-events/attach-screenshots" /> | ||
|
||
## Viewing Screenshots | ||
|
||
Once you've clicked on the event ID of a specific issue, you'll be able to see an overview of all the attachments as well as associated events in the "Attachments" tab. | ||
|
||
 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+245 KB
...des/enriching-events/attach-screenshots/img/attach-screenshot-unreal-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions
29
platform-includes/enriching-events/attach-screenshots/unreal.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
Using the editor menu in **Project Settings > Plugins > Sentry**: | ||
|
||
 | ||
|
||
Or, like so, if you're [configuring things programatically](/platforms/unreal/configuration/options/): | ||
|
||
```cpp | ||
USentrySettings* Settings = FSentryModule::Get().GetSettings(); | ||
Settings->AttachScreenshot = true; | ||
``` | ||
|
||
<Note> | ||
|
||
Currently, this feature is supported for Windows and Linux only. | ||
|
||
</Note> | ||
|
||
## Screenshot Capture Mechanism | ||
|
||
Since the Unreal Engine SDK consists of multiple SDKs, the specific mechanism with which a screenshot is captured will vary depending on where the error originated. | ||
|
||
- On Windows/Linux, errors from within your game will be captured using the Unreal Engine API. This means that screenshots will only contain what's visible within your game. Any overlays on top of your game won't be visible. | ||
- On Apple/Android, screenshots will be captured using platform APIs. If you're using a native plugin to display an overlay and an error occurs, the SDK will try to capture a screenshot that contains the overlay. | ||
|
||
<Note> | ||
|
||
**Screenshots may contain PII.** For example, if your game has a registration form and an error occurs while the form is being displayed. | ||
|
||
</Note> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could clarify that it's still limited to the actual game app and not "anything that's an overlay on the screen".