[cuegui] Add optional sentry support (#1460)

If `sentry.dsn` is set on cuegui.yaml, sentry_sdk becomes active and
will capture exceptions.

Author: DiegoTavares

cuegui/cuegui/Constants.py

@@ -155,6 +155,8 @@ def __packaged_version():
 
 ALLOWED_TAGS = tuple(__config.get('allowed_tags'))
 
+SENTRY_DSN = __config.get('sentry.dsn')
+
 DARK_STYLE_SHEET = os.path.join(CONFIG_PATH, __config.get('style.style_sheet'))
 COLOR_THEME = __config.get('style.color_theme')
 __bg_colors = __config.get('style.colors.background')

cuegui/cuegui/Main.py

@@ -20,6 +20,7 @@
 from __future__ import print_function
 from __future__ import division
 
+import getpass
 import signal
 
 from qtpy import QtGui
@@ -72,6 +73,8 @@ def startup(app_name, app_version, argv):
     settings = cuegui.Layout.startup(app_name)
     app.settings = settings
 
+    __setup_sentry()
+
     cuegui.Style.init()
 
     mainWindow = cuegui.MainWindow.MainWindow(app_name, app_version,  None)
@@ -92,6 +95,23 @@ def startup(app_name, app_version, argv):
     app.aboutToQuit.connect(closingTime)  # pylint: disable=no-member
     app.exec_()
 
+
+def __setup_sentry():
+    """Setup sentry if cuegui.Constants.SENTRY_DSN is defined, nop otherwise"""
+    if not cuegui.Constants.SENTRY_DSN:
+        return
+
+    try:
+        # pylint: disable=import-outside-toplevel
+        # Avoid importing sentry on the top level to make this dependency optional
+        import sentry_sdk
+        sentry_sdk.init(cuegui.Constants.SENTRY_DSN)
+        sentry_sdk.set_user({
+            'username': getpass.getuser()
+        })
+    except ImportError:
+        logger.warning('Failed to import Sentry')
+
 def closingTime():
     """Window close callback."""
     logger.info("Closing all threads...")

cuegui/cuegui/config/cuegui.yaml

@@ -64,6 +64,10 @@ editor.windows: 'notepad'
 editor.mac: 'open -t'
 editor.linux: 'gview -R -m -M -U {config_path}/gvimrc +'
 
+# Url to the sentry application dsn
+# comment out to disable sentry
+# sentry.dsn: 'https://[email protected]/10'
+
 resources:
   # The max cores and max memory based on the available hardware.
   # These values are used by: