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.

Because screenshots may contain PII, they are an opt-in feature. You can enable screenshots as shown below:

Using the editor integrations in Tools > Sentry:

Options Screenshot Configuration

Or, like so, if you're configuring things programatically:

options.AttachScreenshot = true;

Since the Unity SDK internally consists of multiple SDKs, the mechanism with which a screenshot gets captured depends on where the error originates.

  • C# errors from within your game will be captured through Unity's built-in ScreenCapture. This means that screenshots only contain things visible within your game. Overlays on top of your game will not be visible.
  • Native errors get captured by their respective SDK. If you're using a native plugin to display an overlay and an error occurs then that SDK will try to capture a screenshot that contains the overlay.

Screenshots might contain PII of your app. For example, if your game has a registration form and an error happens while the form is being displayed.

If one is available, you'll see a thumbnail of the screenshot when you click on a specific issue from the Issues page.

Screenshot Thumbnail

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

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").