Merge pull request getsentry#445 from chronossc/add_sentry_id_header_to_flask_response

Use flask request_finished signal to add X-Sentry-ID in flask responses.

Author: dcramer

raven/contrib/flask.py

@@ -20,7 +20,7 @@
 import logging
 
 from flask import request, current_app
-from flask.signals import got_request_exception
+from flask.signals import got_request_exception, request_finished
 from raven.conf import setup_logging
 from raven.base import Client
 from raven.middleware import Sentry as SentryMiddleware
@@ -177,6 +177,10 @@ def before_request(self, *args, **kwargs):
         self.client.http_context(self.get_http_info(request))
         self.client.user_context(self.get_user_info(request))
 
+    def add_sentry_id_header(self, sender, response, *args, **kwargs):
+        response.headers['X-Sentry-ID'] = self.last_event_id
+        return response
+
     def init_app(self, app, dsn=None):
         if dsn is not None:
             self.dsn = dsn
@@ -194,6 +198,7 @@ def init_app(self, app, dsn=None):
 
         if self.register_signal:
             got_request_exception.connect(self.handle_exception, sender=app)
+            request_finished.connect(self.add_sentry_id_header, sender=app)
 
         if not hasattr(app, 'extensions'):
             app.extensions = {}

tests/contrib/flask/tests.py

@@ -174,6 +174,7 @@ def test_captureException_captures_http(self):
         self.assertEquals(len(self.raven.events), 1)
 
         event = self.raven.events.pop(0)
+        self.assertEquals(event['event_id'], response.headers['X-Sentry-ID'])
 
         assert event['message'] == 'ValueError: Boom'
         assert 'sentry.interfaces.Http' in event
@@ -185,6 +186,7 @@ def test_captureMessage_captures_http(self):
         self.assertEquals(len(self.raven.events), 1)
 
         event = self.raven.events.pop(0)
+        self.assertEquals(event['event_id'], response.headers['X-Sentry-ID'])
 
         self.assertTrue('sentry.interfaces.Message' in event)
         self.assertTrue('sentry.interfaces.Http' in event)