summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2016-04-21 20:33:37 +0200
committerArmin Ronacher <armin.ronacher@active-4.com>2016-04-21 20:33:42 +0200
commite57f2ce0399dfb0a315c6f22540669d79ecb071f (patch)
treec24f51a06a0b4a28d794b0a06d0d2351c4ee7a8e
parentef48a4aedf965ba2df953756e526208291d2bd0c (diff)
downloadraven-e57f2ce0399dfb0a315c6f22540669d79ecb071f.tar.gz
Added user feedback to flask
-rw-r--r--docs/integrations/flask.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/integrations/flask.rst b/docs/integrations/flask.rst
index 8fc4e1a..fd29ec9 100644
--- a/docs/integrations/flask.rst
+++ b/docs/integrations/flask.rst
@@ -124,6 +124,49 @@ ID if have done a custom error 500 page.
<p>The error identifier is {{ g.sentry_event_id }}</p>
{% endif %}
+User Feedback
+-------------
+
+To enable user feedback for crash reports just make sure you have a custom
+`500` error handler and render out a HTML snippet for bringing up the
+crash dialog:
+
+.. sourcecode:: python
+
+ from flask import Flask, g, render_template
+ from raven.contrib.flask import Sentry
+
+ app = Flask(__name__)
+ sentry = Sentry(app, dsn='___DSN___')
+
+ @app.errorhandler(500
+ def internal_server_error(error):
+ return render_template('500.html',
+ event_id=g.sentry_event_id,
+ public_dsn=sentry.client.get_public_dsn('https')
+ )
+
+And in the error template (``500.html``) you can then do this:
+
+.. sourcecode:: html+jinja
+
+ <!-- Sentry JS SDK 2.1.+ required -->
+ <script src="https://cdn.ravenjs.com/2.3.0/raven.min.js"></script>
+
+ {% if event_id %}
+ <script>
+ Raven.showReportDialog({
+ eventId: '{{ event_id }}',
+ dsn: '{{ public_dsn }}'
+ });
+ </script>
+ {% endif %}
+
+That's it!
+
+For more details on this feature, see the :doc:`User Feedback guide
+<../../../learn/user-feedback>`.
+
Dealing With Proxies
--------------------