Set Up User Feedback
Learn more about collecting user feedback when an event occurs. Sentry pairs the feedback with the original event, giving you additional insight into issues.
When a user experiences an error, Sentry provides the ability to collect additional feedback. You can collect feedback according to the method supported by the SDK.
Our embeddable, JavaScript-based, Crash-Report modal is useful when you would typically render a plain error page (the classic 500.html) on your website.
To collect feedback, the Crash-Report modal requests and collects the user's name, email address, and a description of what occurred. When feedback is provided, Sentry pairs the feedback with the original event, giving you additional insights into issues.
The screenshot below provides an example of the Crash-Report modal, though yours may differ depending on your customization:
The modal authenticates with your public DSN, then passes in the Event ID that was generated on your backend.
In Rails, being able to serve dynamic (for example, .html.erb) pages in response to errors is required to pass the needed event_id to the JavaScript SDK. Typically, this is done by overwriting the config.exceptions_app setting to point to your own router, and then calling your own controller to handle the error. You can find more detailed instructions for this configuration online or install a gem to handle this for you.
Once you're able to serve dynamic exception pages, you can support user feedback.
Make sure you've got the JavaScript SDK available:
<script
src="https://browser.sentry-cdn.com/8.40.0/bundle.min.js"
integrity="sha384-nggeAmqVTUejZLHwH4xL5xehxXjuQbRw9CBDduGWAg3aG2ae+Bq+ff59/858SfHp"
crossorigin="anonymous"
></script>
Additionally, you need the template that brings up the dialog:
<% sentry_id = request.env["sentry.error_event_id"] %>
<% if sentry_id.present? %>
<script>
Sentry.init({ dsn: "https://examplePublicKey@o0.ingest.sentry.io/0" });
Sentry.showReportDialog({ eventId: "<%= sentry_id %>" });
</script>
<% end %>
If you'd prefer an alternative to the modal or do not have a JavaScript frontend, you can use the User Feedback API.
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").