Merge pull request #1639 from IFRCGo/feature/sentry-integration

Feature/sentry integration

Author: szabozoltan69

main/celery.py

@@ -1,9 +1,17 @@
 import os
 import celery
 
+from django.conf import settings
+from main import sentry
+
 
 class CustomCeleryApp(celery.Celery):
-    pass
+    def on_configure(self):
+        if settings.SENTRY_DSN:
+            sentry.init_sentry(
+                app_type='WORKER',
+                **settings.SENTRY_CONFIG,
+            )
 
 
 # set the default Django settings module for the 'celery' program.

main/exception_handler.py

@@ -0,0 +1,36 @@
+import sentry_sdk
+
+from rest_framework.views import exception_handler
+from rest_framework.response import Response
+from rest_framework import status
+
+
+standard_error_string = (
+    'Something unexpected has occured. '
+    'Please contact an admin to fix this issue.'
+)
+
+
+def custom_exception_handler(exc, context):
+    # Default exception handler
+    response = exception_handler(exc, context)
+
+    # For 500 errors, we create new response and add extra attributes to sentry
+    if not response:
+        request = context.get('request')
+        if request and request.user and request.user.id:
+            with sentry_sdk.configure_scope() as scope:
+                scope.user = {
+                    'id': request.user.id,
+                    'email': request.user.email,
+                }
+                scope.set_extra('is_superuser', request.user.is_superuser)
+        sentry_sdk.capture_exception()
+        response_data = {
+            'errors': {
+                'non_field_errors': [standard_error_string]
+            },
+        }
+        response = Response(response_data, status=status.HTTP_500_INTERNAL_SERVER_ERROR)
+
+    return response

main/sentry.py

@@ -0,0 +1,96 @@
+import os
+
+import sentry_sdk
+from django.core.exceptions import PermissionDenied
+from celery.exceptions import Retry as CeleryRetry
+from sentry_sdk.integrations.logging import ignore_logger
+from sentry_sdk.integrations.celery import CeleryIntegration
+from sentry_sdk.integrations.django import DjangoIntegration
+from sentry_sdk.integrations.redis import RedisIntegration
+
+# Celery Terminated Exception: The worker processing a job has been terminated by user request.
+from billiard.exceptions import Terminated
+
+IGNORED_ERRORS = [
+    Terminated,
+    PermissionDenied,
+    CeleryRetry,
+]
+IGNORED_LOGGERS = [
+    'django.core.exceptions.ObjectDoesNotExist',
+]
+
+for _logger in IGNORED_LOGGERS:
+    ignore_logger(_logger)
+
+
+class InvalidGitRepository(Exception):
+    pass
+
+
+def fetch_git_sha(path, head=None):
+    """
+    Source: https://github.com/getsentry/raven-python/blob/03559bb05fd963e2be96372ae89fb0bce751d26d/raven/versioning.py
+    >>> fetch_git_sha(os.path.dirname(__file__))
+    """
+    if not head:
+        head_path = os.path.join(path, '.git', 'HEAD')
+        if not os.path.exists(head_path):
+            raise InvalidGitRepository(
+                'Cannot identify HEAD for git repository at %s' % (path,))
+
+        with open(head_path, 'r') as fp:
+            head = str(fp.read()).strip()
+
+        if head.startswith('ref: '):
+            head = head[5:]
+            revision_file = os.path.join(
+                path, '.git', *head.split('/')
+            )
+        else:
+            return head
+    else:
+        revision_file = os.path.join(path, '.git', 'refs', 'heads', head)
+
+    if not os.path.exists(revision_file):
+        if not os.path.exists(os.path.join(path, '.git')):
+            raise InvalidGitRepository(
+                '%s does not seem to be the root of a git repository' % (path,))
+
+        # Check for our .git/packed-refs' file since a `git gc` may have run
+        # https://git-scm.com/book/en/v2/Git-Internals-Maintenance-and-Data-Recovery
+        packed_file = os.path.join(path, '.git', 'packed-refs')
+        if os.path.exists(packed_file):
+            with open(packed_file) as fh:
+                for line in fh:
+                    line = line.rstrip()
+                    if line and line[:1] not in ('#', '^'):
+                        try:
+                            revision, ref = line.split(' ', 1)
+                        except ValueError:
+                            continue
+                        if ref == head:
+                            return str(revision)
+
+        raise InvalidGitRepository(
+            'Unable to find ref to head "%s" in repository' % (head,))
+
+    with open(revision_file) as fh:
+        return str(fh.read()).strip()
+
+
+def init_sentry(app_type, tags={}, **config):
+    integrations = [
+        CeleryIntegration(),
+        DjangoIntegration(),
+        RedisIntegration(),
+    ]
+    sentry_sdk.init(
+        **config,
+        ignore_errors=IGNORED_ERRORS,
+        integrations=integrations,
+    )
+    with sentry_sdk.configure_scope() as scope:
+        scope.set_tag('app_type', app_type)
+        for tag, value in tags.items():
+            scope.set_tag(tag, value)

main/settings.py

@@ -7,6 +7,9 @@
 from django.utils.translation import gettext_lazy as _
 # from celery.schedules import crontab
 from urllib3.util.retry import Retry
+from corsheaders.defaults import default_headers
+
+from main import sentry
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
@@ -72,6 +75,9 @@
     # Appeal Server Credentials (https://go-api.ifrc.org/api/)
     APPEALS_USER=(str, None),
     APPEALS_PASS=(str, None),
+    # Sentry
+    SENTRY_DSN=(str, None),
+    SENTRY_SAMPLE_RATE=(float, 0.2),
 )
 
 
@@ -172,6 +178,7 @@
         'rest_framework.authentication.BasicAuthentication',
         'rest_framework.authentication.SessionAuthentication',
     ),
+    'EXCEPTION_HANDLER': 'main.exception_handler.custom_exception_handler',
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
     'PAGE_SIZE': 50,
     'DEFAULT_FILTER_BACKENDS': (
@@ -214,6 +221,9 @@
 )
 
 CORS_ORIGIN_ALLOW_ALL = True
+CORS_ALLOW_HEADERS = list(default_headers) + [
+    'sentry-trace',
+]
 
 ROOT_URLCONF = 'main.urls'
 
@@ -479,3 +489,24 @@
 # Appeal Server Credentials
 APPEALS_USER = env('APPEALS_USER')
 APPEALS_PASS = env('APPEALS_PASS')
+
+# Sentry Config
+SENTRY_DSN = env('SENTRY_DSN')
+SENTRY_SAMPLE_RATE = env('SENTRY_SAMPLE_RATE')
+
+SENTRY_CONFIG = {
+    'dsn': SENTRY_DSN,
+    'send_default_pii': True,
+    'traces_sample_rate': SENTRY_SAMPLE_RATE,
+    'release': sentry.fetch_git_sha(BASE_DIR),
+    'environment': GO_ENVIRONMENT,
+    'debug': DEBUG,
+    'tags': {
+        'site': GO_API_FQDN,
+    },
+}
+if SENTRY_DSN:
+    sentry.init_sentry(
+        app_type='API',
+        **SENTRY_CONFIG,
+    )