-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(feedback): product docs #8539
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
5ddc1f5
feat(feedback): product docs
bruno-garcia 2829706
[getsentry/action-github-commit] Auto commit
getsantry[bot] 9ff5b55
Apply suggestions from code review
bruno-garcia d6e19ca
Apply suggestions from code review
bruno-garcia 365467a
modal
bruno-garcia bb456d9
Apply suggestions from code review
bruno-garcia 9972a06
remove note
bruno-garcia c435e15
new imgs
bruno-garcia f9c515e
trimmed edges
bruno-garcia 35d0686
Update src/docs/product/user-feedback/index.mdx
bruno-garcia 567d9dc
Merge branch 'master' into feat/user-feedback-product-docs
bruno-garcia 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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 |
|---|---|---|
| @@ -1,25 +1,70 @@ | ||
| --- | ||
| title: User Feedback | ||
| sidebar_order: 120 | ||
| sidebar_order: 65 | ||
| description: "Learn how you can view user feedback submissions which, paired with the original event, give you additional insight into issues." | ||
| --- | ||
|
|
||
| While event data allows you to collect information about errors in your application, getting any extra helpful feedback can be crucial in determining the root cause of an issue. Sentry provides the ability to collect additional information with User Feedback. | ||
| Sentry automatically detects errors thrown by your application, such as performance issues and user experience problems like rage clicks. But there are other frustrations your users may encounter (broken permission flows, broken links, typos, misleading UX, business logic flaws, and so on). | ||
|
|
||
| The **User Feedback** page in [sentry.io](https://sentry.io) displays feedback submissions from users who experienced an error while using your application. Each submission includes the name and email address entered by the user, as well as their description of what happened to produce the error: | ||
| That’s where Sentry’s User Feedback Widget and Crash-Report Modal features come in. Setting up one or both, lets you collect feedback from your end-users when they run into bugs in your application. Sentry then links that feedback to available rich debugging context, including errors, replays, and tags such as URL, allowing you to get to the root of the problem faster. | ||
|
|
||
|  | ||
| For example, using [Session Replay](/product/session-replay/) with the User Feedback Widget could save you time, helping you quickly understand the context of the user problem by seeing exactly what they experienced before submitting their feedback. | ||
|
|
||
| In each submission, you can click the “View Event” link, which takes you to the **Issue Details** page for that error event (or instance of the issue). From there, you can dig into what caused the issue and start working to resolve it: | ||
| ## User Feedback Widget | ||
|
|
||
|  | ||
| The User Feedback Widget is an out-of-the-box, persistent widget you can add anywhere on your web application. It allows users to submit feedback quickly and easily any time they encounter something that isn’t working as expected. Learn more about how to install and customize it [here](https://docs.sentry.io/product/user-feedback/setup/). | ||
|
|
||
| <Note> | ||
|  | ||
bruno-garcia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| User feedback is only applicable for [error issues](/product/issues/issue-details/error-issues/). Other categories of issues (such as [performance issues](/product/issues/issue-details/performance-issues/)) do not support this feature. | ||
| Feedback collected via the Feedback Widget may have some or all of the following information (depending on what you mark as required and what’s available from the error context): | ||
|
|
||
| </Note> | ||
| - Description from the user | ||
| - User email | ||
| - Associated replay event (with up to 60 seconds of replay recording before the user submitted the feedback) | ||
| - Learn more about how to set up Session Replay [here](/product/session-replay/getting-started/). | ||
| - URL of the page the user was on when they submitted the feedback | ||
| - Tags | ||
|
|
||
| ## Set Up | ||
| ## Crash-Report Modal | ||
|
|
||
| There are two ways to collect user feedback in Sentry: via [a web API](https://docs.sentry.io/api/projects/submit-user-feedback/), or by using an embeddable widget or API in the SDK itself, which you can [configure](/platform-redirect/?next=/user-feedback/) to collect feedback when a user experiences an error. | ||
| Another way to collect feedback is by installing the Crash-Report Modal. This allows users to submit feedback after they experience an error via an automatic modal that pops up after an error occurs. Learn more about how to install and customize it [here](https://docs.sentry.io/platforms/javascript/enriching-events/user-feedback/#embeddable-javascript-widget). | ||
|
|
||
|  | ||
|
|
||
| Feedback collected via the Crash-Report Modal will have the following information: | ||
|
|
||
| - Description from the user | ||
| - Sentry Issue preview and link to the Issue Details page | ||
| - URL of the page the user was on when they submitted the feedback | ||
| - Tags | ||
|
|
||
| ## Where to View User Feedback | ||
|
|
||
| Whether you choose to collect user feedback via the Feedback Widget, the Crash-Report Modal, or both, you’ll be able to view it from the **User Feedback** page. The page is chronologically-organized with the most recent, unresolved feedback at the top. You can click on individual feedback to see more details all in one view, similar to your e-mail inbox. The right-hand side shows the **User Feedback Details** view, which includes the user’s description and any available debugging context. | ||
|
|
||
| You can narrow down the results in the feedback list by using the project, environment, and date range filters. | ||
|
|
||
|  | ||
|
|
||
| ## Triaging User Feedback Submissions | ||
|
|
||
| You can either manually resolve user feedback submissions on the **User Feedback Details** view by clicking the “Resolve” button in the top-right corner, or bulk resolve by multi-selecting the feedback: | ||
|
|
||
|  | ||
|
|
||
| You can also assign a team member to a specific user feedback submission on the **User Feedback Details** view. | ||
|
|
||
| ## Getting User Feedback Alerts | ||
|
|
||
| If you have Sentry's default issue alert ("Alert me on every new issue") turned on for the project(s) with user feedback set up, then you should automatically get alerted every time new user feedback comes in via the User Feedback Widget. | ||
|
|
||
| If you don't have Sentry's default issue alert turned on, follow these steps to set up alerts for every new feedback: | ||
|
|
||
| 1. Create a [New Alert Rule](https://sentry.io/alerts/new/issue/) in Sentry. | ||
| 2. Scroll to the "Set conditions" section and set the "IF" filter to `The issue's category is equal to… "Feedback"`. | ||
| 3. Choose which actions to perform in the “THEN” filter. | ||
| 4. Add an alert name and owner. | ||
|
|
||
|  | ||
|
|
||
| To be alerted when crash-report feedback comes in, set up Workflow Notifications as described [here](https://docs.sentry.io/product/alerts/notifications/#workflow-notifications). | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
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.
Uh oh!
There was an error while loading. Please reload this page.