-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add screenshot feature description for Unreal Engine (#11042)
* Add screenshot feature description for Unreal Engine * Update screenshot * Update docs/platforms/unreal/enriching-events/screenshots/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update platform-includes/enriching-events/attach-screenshots/unreal.mdx Co-authored-by: Liza Mock <[email protected]> * Update platform-includes/enriching-events/attach-screenshots/unreal.mdx Co-authored-by: Liza Mock <[email protected]> * Update platform-includes/enriching-events/attach-screenshots/unreal.mdx Co-authored-by: Liza Mock <[email protected]> * Update platform-includes/enriching-events/attach-screenshots/unreal.mdx --------- Co-authored-by: Liza Mock <[email protected]>
- Loading branch information
1 parent
c3f7a15
commit 3daab70
Showing
6 changed files
with
57 additions
and
0 deletions.
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. | ||
|
||
![Screenshots List Example](./img/screenshot-list-example.png) |
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**: | ||
|
||
![Options Screenshot Configuration](./img/attach-screenshot-unreal-editor.png) | ||
|
||
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> |