feat: celery integration (#8)

* feat: celery integration

* chore: skip tests if celery not installed

Author: untitaker

sentry_sdk/hub.py

@@ -112,25 +112,32 @@ def capture_exception(self, error=None):
             return
         if error is None:
             exc_type, exc_value, tb = sys.exc_info()
+        elif isinstance(error, tuple) and len(error) == 3:
+            exc_type, exc_value, tb = error
         else:
             tb = getattr(error, '__traceback__', None)
             if tb is not None:
                 exc_type = type(error)
                 exc_value = error
             else:
                 exc_type, exc_value, tb = sys.exc_info()
-                tb = skip_internal_frames(tb)
                 if exc_value is not error:
                     tb = None
                     exc_value = error
                     exc_type = type(error)
 
+        if tb is not None:
+            tb = skip_internal_frames(tb)
+
         event = create_event()
-        event['exception'] = {
-            'values': exceptions_from_error_tuple(
-                exc_type, exc_value, tb, client.options['with_locals'])
-        }
-        return self.capture_event(event)
+        try:
+            event['exception'] = {
+                'values': exceptions_from_error_tuple(
+                    exc_type, exc_value, tb, client.options['with_locals'])
+            }
+            return self.capture_event(event)
+        except Exception:
+            capture_internal_exception()
 
     def capture_internal_exception(self, error=None):
         """Capture an exception that is likely caused by a bug in the SDK

sentry_sdk/integrations/celery.py

@@ -0,0 +1,45 @@
+from __future__ import absolute_import
+
+from celery.signals import (
+    after_setup_logger, task_failure, task_prerun, task_postrun
+)
+
+from sentry_sdk import get_current_hub, configure_scope, capture_exception
+from sentry_sdk.utils import ContextVar
+
+
+def install():
+    task_prerun.connect(_handle_task_prerun, weak=False)
+    task_postrun.connect(_handle_task_postrun, weak=False)
+    task_failure.connect(_process_failure_signal, weak=False)
+
+
+def _process_failure_signal(sender, task_id, einfo, **kw):
+    if hasattr(sender, 'throws') and isinstance(einfo.exception, sender.throws):
+        return
+
+    capture_exception(einfo.exc_info)
+
+
+_task_scope = ContextVar('sentry_celery_task_scope')
+
+
+def _handle_task_prerun(sender, task, **kw):
+    try:
+        assert _task_scope.get(None) is None, 'race condition'
+        _task_scope.set(get_current_hub().push_scope().__enter__())
+
+        with configure_scope() as scope:
+            scope.transaction = task.name
+    except Exception:
+        get_current_hub().capture_internal_exception()
+
+
+def _handle_task_postrun(sender, task_id, task, **kw):
+    try:
+        val = _task_scope.get(None)
+        assert val is not None, 'race condition'
+        val.__exit__(None, None, None)
+        _task_scope.set(None)
+    except Exception:
+        get_current_hub().capture_internal_exception()

sentry_sdk/integrations/django/__init__.py

@@ -31,21 +31,24 @@ def _get_transaction_from_request(request):
 # not yet available
 class SentryMiddleware(MiddlewareMixin):
     def process_request(self, request):
-        assert _request_scope.get(None) is None, 'race condition'
-        _request_scope.set(get_current_hub().push_scope().__enter__())
-
         try:
+            assert _request_scope.get(None) is None, 'race condition'
+            _request_scope.set(get_current_hub().push_scope().__enter__())
+
             with configure_scope() as scope:
                 scope.transaction = _get_transaction_from_request(request)
         except Exception:
-            capture_exception()
+            get_current_hub().capture_internal_exception()
 
 
 def _request_finished(*args, **kwargs):
-    val = _request_scope.get(None)
-    assert val is not None, 'race condition'
-    val.__exit__(None, None, None)
-    _request_scope.set(None)
+    try:
+        val = _request_scope.get(None)
+        assert val is not None, 'race condition'
+        val.__exit__(None, None, None)
+        _request_scope.set(None)
+    except Exception:
+        get_current_hub().capture_internal_exception()
 
 
 def _got_request_exception(request=None, **kwargs):

sentry_sdk/integrations/flask.py

@@ -31,50 +31,59 @@ def init_app(self, app):
 
 
 def _push_appctx(*args, **kwargs):
-    assert getattr(
-        _app_ctx_stack.top,
-        '_sentry_app_scope_manager',
-        None
-    ) is None, 'race condition'
-    _app_ctx_stack.top._sentry_app_scope_manager = \
-        get_current_hub().push_scope().__enter__()
+    try:
+        assert getattr(
+            _app_ctx_stack.top,
+            '_sentry_app_scope_manager',
+            None
+        ) is None, 'race condition'
+        _app_ctx_stack.top._sentry_app_scope_manager = \
+            get_current_hub().push_scope().__enter__()
+    except Exception:
+        get_current_hub().capture_internal_exception()
 
 
 def _pop_appctx(exception):
-    assert getattr(
-        _app_ctx_stack.top,
-        '_sentry_app_scope_manager',
-        None
-    ) is not None, 'race condition'
-    _app_ctx_stack.top._sentry_app_scope_manager.__exit__(None, None, None)
-    _app_ctx_stack.top._sentry_app_scope_manager = None
+    try:
+        assert getattr(
+            _app_ctx_stack.top,
+            '_sentry_app_scope_manager',
+            None
+        ) is not None, 'race condition'
+        _app_ctx_stack.top._sentry_app_scope_manager.__exit__(None, None, None)
+        _app_ctx_stack.top._sentry_app_scope_manager = None
+    except Exception:
+        get_current_hub().capture_internal_exception()
 
 
 def _capture_exception(sender, exception, **kwargs):
     capture_exception(exception)
 
 
 def _before_request(*args, **kwargs):
-    assert getattr(
-        _app_ctx_stack.top,
-        '_sentry_app_scope_manager',
-        None
-    ) is not None, 'scope push failed'
-
-    with configure_scope() as scope:
-        if request.url_rule:
-            scope.transaction = request.url_rule.endpoint
-
-        try:
-            scope.request = _get_request_info()
-        except Exception:
-            get_current_hub().capture_internal_exception()
-
-        try:
-            scope.user = _get_user_info()
-        except Exception:
-            raise
-            get_current_hub().capture_internal_exception()
+    try:
+        assert getattr(
+            _app_ctx_stack.top,
+            '_sentry_app_scope_manager',
+            None
+        ) is not None, 'scope push failed'
+
+        with configure_scope() as scope:
+            if request.url_rule:
+                scope.transaction = request.url_rule.endpoint
+
+            try:
+                scope.request = _get_request_info()
+            except Exception:
+                get_current_hub().capture_internal_exception()
+
+            try:
+                scope.user = _get_user_info()
+            except Exception:
+                raise
+                get_current_hub().capture_internal_exception()
+    except Exception:
+        get_current_hub().capture_internal_exception()
 
 def _get_request_info():
     {

tests/integrations/celery/test_celery.py

@@ -0,0 +1,40 @@
+import pytest
+
+pytest.importorskip('celery')
+
+from celery import Celery
+
+from sentry_sdk.integrations.celery import install
+
+install()
+
+
+@pytest.fixture
+def celery():
+    celery = Celery(__name__)
+    celery.conf.CELERY_ALWAYS_EAGER = True
+    return celery
+
+
+def test_simple(capture_events, celery):
+    @celery.task(name='dummy_task')
+    def dummy_task(x, y):
+        return x / y
+
+    dummy_task.delay(1, 2)
+    dummy_task.delay(1, 0)
+    event, = capture_events
+    assert event['transaction'] == 'dummy_task'
+
+    exception, = event['exception']['values']
+    assert exception['type'] == 'ZeroDivisionError'
+
+
+def test_ignore_expected(capture_events, celery):
+    @celery.task(name='dummy_task', throws=(ZeroDivisionError,))
+    def dummy_task(x, y):
+        return x / y
+
+    dummy_task.delay(1, 2)
+    dummy_task.delay(1, 0)
+    assert not capture_events

tox.ini

@@ -18,9 +18,11 @@ envlist =
     {py27,py34,py35}-django-18
     {py27,py34}-django-17
     py27-django-16
-    {py27,py35}-flask-{10,11}
-    py35-flask-12
-    py35-flask-dev
+
+    {py27,py35,py36,py37}-flask-{10,11,12,dev}
+
+    {py27,py35,py36,py37}-celery-4
+    py27-celery-3
 
 
 [testenv]
@@ -42,12 +44,11 @@ deps =
     flask-11: Flask>=0.11,<0.12
     flask-12: Flask>=0.12,<0.13
     flask-dev: git+https://github.com/pallets/flask.git#egg=flask
+    celery-3: Celery>=3.1,<4.0
+    celery-4: Celery>=4.0,<5.0
     flask: flask-login
 setenv =
     PYTHONDONTWRITEBYTECODE=1
-    TESTPATH=tests
-    django: TESTPATH=tests/integrations/django
-    flask: TESTPATH=tests/integrations/flask
 usedevelop = True
 extras =
     flask: flask
@@ -61,4 +62,4 @@ basepython =
     pypy: pypy
 
 commands =
-    py.test {env:TESTPATH} {posargs}
+    py.test {posargs}