Replaced raven with sentry-sdk

Author: vdboor

src/fluentdemo/__init__.py

@@ -1,6 +0,0 @@
-import raven.exceptions
-
-try:
-    version_sha = raven.fetch_git_sha('..')
-except raven.exceptions.InvalidGitRepository:
-    version_sha = None  # for unit testing

src/fluentdemo/apps/sentry/__init__.py

@@ -0,0 +1 @@
+default_app_config = __name__ + ".apps.BaseAppConfig"

src/fluentdemo/apps/sentry/apps.py

@@ -0,0 +1,15 @@
+from django.apps import AppConfig
+
+from .sentry import init_sentry_sdk
+
+
+class BaseAppConfig(AppConfig):
+    name = 'fluentdemo.apps.sentry'
+
+    def ready(self):
+        """
+        Monkey patch after apps are loaded.
+        """
+        # Moved SDK initialization to ready() moment,
+        # so SENTRY_DSN can be redefined by other setting files.
+        init_sentry_sdk()

src/fluentdemo/apps/sentry/sentry.py

@@ -0,0 +1,22 @@
+import logging
+
+import sentry_sdk
+from django.conf import settings
+from sentry_sdk.integrations.django import DjangoIntegration
+from sentry_sdk.integrations.logging import LoggingIntegration
+from sentry_sdk.integrations.redis import RedisIntegration
+
+
+def init_sentry_sdk():
+    """Initialize the sentry SDK"""
+    if settings.SENTRY_DSN:
+        sentry_sdk.init(
+            settings.SENTRY_DSN,
+            environment=settings.SENTRY_ENVIRONMENT,
+            release=settings.GIT_VERSION,
+            integrations=[
+                LoggingIntegration(event_level=logging.WARNING),
+                DjangoIntegration(transaction_style="function_name"),
+                RedisIntegration(),
+            ]
+        )

src/fluentdemo/apps/sentry/versioning.py

@@ -0,0 +1,58 @@
+"""
+Copied from old sentry-raven integration.
+"""
+import os.path
+
+
+class InvalidGitRepository(Exception):
+    pass
+
+
+def fetch_git_sha(path, head=None):
+    """
+    >>> 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()

src/fluentdemo/settings/defaults.py

@@ -3,10 +3,11 @@
 """
 import logging
 import os
+import sys
 
 import environ
-import raven.exceptions
 from django.utils.translation import ugettext_lazy as _
+from fluentdemo.apps.sentry.versioning import InvalidGitRepository, fetch_git_sha
 
 env = environ.Env()
 
@@ -88,6 +89,7 @@
     # Site parts
     'frontend',
     'fluentdemo.apps.blog',
+    'fluentdemo.apps.sentry',
     'fluentdemo.apps.wysiwyg_config',
 
     # CMS parts
@@ -176,8 +178,6 @@
 )
 
 MIDDLEWARE = (
-    'raven.contrib.django.middleware.SentryMiddleware',  # make 'request' available on all logs.
-    'raven.contrib.django.middleware.Sentry404CatchMiddleware',  # on 404, report to sentry.
     'django.middleware.security.SecurityMiddleware',
     'whitenoise.middleware.WhiteNoiseMiddleware',
     'django.middleware.common.CommonMiddleware',
@@ -234,15 +234,14 @@
 
 locals().update(env.email_url(default='smtp://'))
 
-RAVEN_CONFIG = {
-    'dsn': env.str('SENTRY_DSN', default=''),
-}
-
 try:
-    GIT_VERSION = raven.fetch_git_sha('..')
-    RAVEN_CONFIG['release'] = GIT_VERSION
-except raven.exceptions.InvalidGitRepository:
-    pass
+    GIT_VERSION = fetch_git_sha(ROOT_DIR)
+except InvalidGitRepository as e:
+    sys.stderr.write(str(e) + "\n")
+    GIT_VERSION = None
+
+SENTRY_DSN = env.str('SENTRY_DSN', default='')
+SENTRY_ENVIRONMENT = env.str('SENTRY_ENVIRONMENT', default='dev')
 
 LOGGING = {
     'version': 1,
@@ -266,10 +265,6 @@
             'filters': ['require_debug_false'],
             'class': 'django.utils.log.AdminEmailHandler'
         },
-        'sentry': {
-            'level': 'WARNING',
-            'class': 'raven.contrib.django.handlers.SentryHandler',
-        },
         'console': {
             'level': 'DEBUG',
             'class': 'logging.StreamHandler',
@@ -286,11 +281,6 @@
             'level': 'ERROR',
             'propagate': True,
         },
-        'raven': {
-            'level': 'DEBUG',
-            'handlers': ['console'],
-            'propagate': False,
-        },
     }
 }
 

src/fluentdemo/settings/production.py

@@ -13,12 +13,6 @@
 FLUENT_CONTENTS_CACHE_OUTPUT = env.bool('FLUENT_CONTENTS_CACHE_OUTPUT', not DEBUG)
 FLUENT_CONTENTS_CACHE_PLACEHOLDER_OUTPUT = env.bool('FLUENT_CONTENTS_CACHE_PLACEHOLDER_OUTPUT', not DEBUG)
 
-# Raven is only enabled in production to avoid warnings in development
-INSTALLED_APPS += (
-    'raven.contrib.django.raven_compat',
-    #'gunicorn',
-)
-
 # Keep templates in memory
 TEMPLATES[0]['OPTIONS']['loaders'] = (
     ('django.template.loaders.cached.Loader', TEMPLATES[0]['OPTIONS']['loaders']),

src/requirements/base.in

@@ -5,7 +5,7 @@ Django == 1.11.29
 Pillow == 7.0.0
 psycopg2 == 2.8.4
 python-memcached == 1.59
-raven == 6.10.0
+sentry-sdk ==  1.3.1
 uWSGI == 2.0.18
 WsgiUnproxy == 1.0
 

src/requirements/base.txt

@@ -15,7 +15,9 @@ beautifulsoup4==4.8.2
 brotlipy==0.7.0
     # via -r requirements/base.in
 certifi==2019.11.28
-    # via requests
+    # via
+    #   requests
+    #   sentry-sdk
 cffi==1.14.0
     # via brotlipy
 chardet==3.0.4
@@ -308,8 +310,6 @@ pytz==2019.3
     #   -r requirements/base.in
     #   babel
     #   django
-raven==6.10.0
-    # via -r requirements/base.in
 redis==3.4.1
     # via
     #   -r requirements/base.in
@@ -320,6 +320,8 @@ requests==2.23.0
     # via
     #   django-healthchecks
     #   python-akismet
+sentry-sdk==1.3.1
+    # via -r requirements/base.in
 six==1.14.0
     # via
     #   django-appconf
@@ -353,7 +355,9 @@ unicodecsv==0.14.1
 unidecode==1.1.1
     # via django-forms-builder
 urllib3==1.25.8
-    # via requests
+    # via
+    #   requests
+    #   sentry-sdk
 uwsgi==2.0.18
     # via -r requirements/base.in
 wcwidth==0.1.8