User Feedback

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.

Embeddable JavaScript Widget

Our embeddable JavaScript widget is useful when you may typically render a plain error page (the classic 500.html) on your website.

To collect feedback, the widget 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 User Feedback widget, though yours may differ depending on your customization:

An example of a user feedback widget with text boxes for user name, email, and additional details about the break.

Integration

To integrate the widget, you'll need to be running version 2.1 or newer of our JavaScript SDK. The widget authenticates with your public DSN, then passes in the Event ID that was generated on your backend.

Make sure you've got the JavaScript SDK available:

Copied
<script
  src="https://browser.sentry-cdn.com/6.10.0/bundle.min.js"
  integrity="sha384-nsIkfmMh0uiqg+AwegHcT1SMiPNWnhZmjFDwTshLTxur6ZPNaGT8vwT+vHwI5Jag"
  crossorigin="anonymous"
></script>

Next, create resources/views/errors/500.blade.php, and embed the feedback code:

resources/views/errors/500.blade.php
Copied
<div class="content">
  <div class="title">Something went wrong.</div>

  @if(app()->bound('sentry') && app('sentry')->getLastEventId())
    <div class="subtitle">Error ID: {{ app('sentry')->getLastEventId() }}</div>
    <script>
      Sentry.init({ dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0' });
      Sentry.showReportDialog({
        eventId: '{{ app('sentry')->getLastEventId() }}'
      });
    </script>
  @endif
</div>

For Laravel 5 up to 5.4 there is some extra work needed. You need to open up App/Exceptions/Handler.php and extend the render method to make sure the 500 error is rendered as a view correctly, in 5.5+ this step is not required anymore.

app/Exceptions/Handler.php
Copied
<?php

use Symfony\Component\HttpKernel\Exception\HttpException;

class Handler extends ExceptionHandler
{
    public function report(Exception $exception)
    {
        if (app()->bound('sentry') && $this->shouldReport($exception)) {
            app('sentry')->captureException($exception);
        }

        parent::report($exception);
    }

    // This method is ONLY needed for Laravel 5 up to 5.4.
    // You can skip this method if you are using Laravel 5.5+.
    public function render($request, Exception $exception)
    {
        // Convert all non-http exceptions to a proper 500 http exception
        // if we don't do this exceptions are shown as a default template
        // instead of our own view in resources/views/errors/500.blade.php
        if ($this->shouldReport($exception) && !$this->isHttpException($exception) && !config('app.debug')) {
            $exception = new HttpException(500, 'Whoops!');
        }

        return parent::render($request, $exception);
    }
}

Customizing the Widget

You can customize the widget to your organization's needs, especially for localization purposes. All options can be passed through the showReportDialog call.

An override for Sentry’s automatic language detection (e.g. lang=de)

ParamDefault
eventIdManually set the id of the event.
dsnManually set dsn to report to.
userManually set user data [an object with keys listed below].
user.emailUser's email address.
user.nameUser's name.
lang[automatic]override for Sentry’s language code
titleIt looks like we’re having issues.
subtitleOur team has been notified.
subtitle2If you’d like to help, tell us what happened below. – not visible on small screen resolutions
labelNameName
labelEmailEmail
labelCommentsWhat happened?
labelCloseClose
labelSubmitSubmit
errorGenericAn unknown error occurred while submitting your report. Please try again.
errorFormEntrySome fields were invalid. Please correct the errors and try again.
successMessageYour feedback has been sent. Thank you!
onLoadn/a

User Feedback API

If you'd prefer an alternative to the widget or do not have a JavaScript frontend, you can use the User Feedback API.

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