Merge pull request #6803 from Ultimaker/sentry_crash_integration

Sentry crash integration

plugins/SentryLogger/SentryLogger.py

@@ -0,0 +1,55 @@
+# Copyright (c) 2019 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+
+from UM.Logger import LogOutput
+from typing import Set
+from sentry_sdk import add_breadcrumb
+from typing import Optional
+import os
+
+home_dir = os.path.expanduser("~")
+
+
+class SentryLogger(LogOutput):
+    # Sentry (https://sentry.io) is the service that Cura uses for logging crashes. This logger ensures that the
+    # regular log entries that we create are added as breadcrumbs so when a crash actually happens, they are already
+    # processed and ready for sending.
+    # Note that this only prepares them for sending. It only sends them when the user actually agrees to sending the
+    # information.
+    
+    _levels = {
+        "w": "warning",
+        "i": "info",
+        "c": "fatal",
+        "e": "error",
+        "d": "debug"
+    }
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._show_once = set()  # type: Set[str]
+    
+    ##  Log the message to the sentry hub as a breadcrumb
+    #   \param log_type "e" (error), "i"(info), "d"(debug), "w"(warning) or "c"(critical) (can postfix with "_once")
+    #   \param message String containing message to be logged
+    def log(self, log_type: str, message: str) -> None:
+        level = self._translateLogType(log_type)
+        message = self._pruneSensitiveData(message)
+        if level is None:
+            if message not in self._show_once:
+                level = self._translateLogType(log_type[0])
+                if level is not None:
+                    self._show_once.add(message)
+                    add_breadcrumb(level = level, message = message)
+        else:
+            add_breadcrumb(level = level, message = message)
+
+    @staticmethod
+    def _pruneSensitiveData(message):
+        if home_dir in message:
+            message = message.replace(home_dir, "<user_home>")
+        return message
+
+    @staticmethod
+    def _translateLogType(log_type: str) -> Optional[str]:
+        return SentryLogger._levels.get(log_type)

plugins/SentryLogger/__init__.py

@@ -0,0 +1,16 @@
+# Copyright (c) 2019 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+from typing import TYPE_CHECKING, Dict, Any
+
+from . import SentryLogger
+
+if TYPE_CHECKING:
+    from UM.Application import Application
+
+
+def getMetaData() -> Dict[str, Any]:
+    return {}
+
+
+def register(app: "Application") -> Dict[str, Any]:
+    return {"logger": SentryLogger.SentryLogger()}

plugins/SentryLogger/plugin.json

@@ -0,0 +1,8 @@
+{
+    "name": "Sentry Logger",
+    "author": "Ultimaker B.V.",
+    "version": "1.0.0",
+    "description": "Logs certain events so that they can be used by the crash reporter",
+    "api": "7.0",
+    "i18n-catalog": "cura"
+}