Skip to content

Commit 7177e8e

Browse files
docs: Add product docs for screenshots (#5831)
Add product docs for screenshots Co-authored-by: Isabel <[email protected]>
1 parent bf4d4c1 commit 7177e8e

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

src/docs/product/issues/issue-details/error-issues/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,18 @@ A _suspect commit_ is a commit that's been identified as potentially having caus
5151

5252
The tags displayed in the main section of this page are specific to the event that you're viewing. In contrast, the tags displayed in the right-hand sidebar are a summary of all tag values for all events included in the issue. You can set your own tags to make them more useful for debugging as described in <PlatformLink to="/enriching-events/tags/">Customize Tags</PlatformLink>.
5353

54+
## Screenshot
55+
56+
Sentry provides the ability to take a screenshot and include it as an attachment when a user experiences an error. Screenshot attachments sent as a part of an event are displayed in this section. This feature only applies to SDKs with a user interface. It's supported for the following SDKs:
57+
58+
- [.NET Xamarin](/platforms/dotnet/guides/xamarin/)
59+
- [Android](/platforms/android/enriching-events/screenshots/)
60+
- [Flutter](/platforms/flutter/enriching-events/screenshots/)
61+
- [iOS](/platforms/apple/guides/ios/enriching-events/screenshots/)
62+
- [JavaScript Electron](/platforms/javascript/guides/electron/enriching-events/screenshots/)
63+
- [Unity](/platforms/unity/enriching-events/screenshots/)
64+
65+
5466
## Exception (Stack Trace)
5567

5668
The "Exception" section of the page displays the stack trace, which shows you the line of code that the event errored on:

src/docs/product/issues/issue-details/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ There are two categories of issues: [error issues](/product/issues/issue-details
1919
- **Trace Navigator** - An abbreviated view of the related [trace](/product/sentry-basics/tracing/distributed-tracing) for the current transaction.
2020
- **Suspect Commits** - A commit that's been identified as potentially having caused an error event.
2121
- **Tags** - Searchable key/value string pairs providing information such as the browser or device.
22+
- **Screenshot** - Screenshot taken when a user experiences an error; only available on [certain SDKs](/product/issues/issue-details/error-issues/#screenshots).
2223
- **Exception (Stack Trace)** - Shows you the line of code that the event errored on.
2324
- **Span Evidence** - Information about the performance problem in the context of the current event
2425
- **Breadcrumbs** - Provide a history and timeline leading up to the error event and are customizable.
@@ -33,7 +34,7 @@ This page displays the "Details" tab when it first opens, but several other tabs
3334

3435
- **Activity** - A history of activity for the event where team members can share comments.
3536
- **User Feedback** - Any feedback collected from users through the <PlatformLink to="/enriching-events/user-feedback/">SDK's user feedback</PlatformLink>.
36-
- <PlatformLink to="/enriching-events/attachments/">**Attachments**</PlatformLink> - Stored additional files, such as config or log files that are related to the error event.
37+
- **<PlatformLink to="/enriching-events/attachments/">Attachments</PlatformLink>** - Stored additional files, such as config, log or screenshot files that are related to the error event.
3738
- **Tags** - More detailed information about the tags across all the events included in the issue.
3839
- **All Events** - A list of all the error events included in the issue.
3940
- **Merged Issues** - A list of error issues that have been merged with this one.

src/platforms/common/enriching-events/screenshots.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@ A thumbnail of the screenshot shows up at the top of the **Issue Details** page:
3434
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.
3535

3636
![Screenshots List Example](screenshots/screenshot-list-example.png)
37+
38+
You can see an overview of all the screenshots associated with the events in your issue by clicking "Screenshots" in the "Attachments" tab.

0 commit comments

Comments
 (0)