Screenshots

When a user experiences an error, an exception or a crash, Sentry provides the ability to take a screenshot and include it as an attachment.

This feature only applies to SDKs with a user interface, such as the ones for mobile and desktop applications. In some environments like native iOS, taking a screenshot requires the UI thread and in the event of a crash, that might not be available. 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

Screenshots may contain PII and is an opt-in feature. You can enable it as shown below:

<application>
  <meta-data android:name="io.sentry.attach-screenshot" android:value="true" />
</application>

import io.sentry.android.core.SentryAndroid;

SentryAndroid.init(this, options -> {
    options.setBeforeScreenshotCaptureCallback((event, hint, debounce) -> {
        // always capture crashed events
        if (event.isCrashed()) {
            return true;
        }

        // if debounce is active, skip capturing
        if (debounce) {
            return false;
        } else {
            // also capture fatal events
            return event.getLevel() == SentryLevel.FATAL;
        }
    });
});

Viewing Screenshots

A thumbnail of the screenshot shows up at the top of the Issue Details page:

Additionally, screenshots appear in the "Attachments" tab, where you can view all attachments, as well as associated events. Click the event ID to open the Issue Details page of that specific event.

You can see an overview of all the screenshots associated with the events in your issue by clicking "Screenshots" in the "Attachments" tab.