SentrySDK: Turn on deep integration on demand

Only whenever the sentry_sdk module is there functions of this module will be used.
The only changes, which were needed to be made, are done on cura_app.py and cura.CrashHandler.
Whenever the module is not available, it's functions will be omitted.

The if-clauses could happen earlier, but this at least the bare minimum, and, to be honest, on Ultimaker's distribution it won't speed up anything.
I expect the if-clause to take the same amount of runtime sooner or later. The check is the same and it should be on Ultimaker's distribution always be "True".

Signed-off-by: Thomas Karl Pietrowski <thopiekar@gmail.com> (github: thopiekar)
This commit is contained in:
Thomas Karl Pietrowski 2020-01-02 22:22:44 +01:00
parent c261065d68
commit ba5a0b0085
2 changed files with 70 additions and 48 deletions

View File

@ -12,9 +12,13 @@ import json
import locale
from typing import cast
try:
from sentry_sdk.hub import Hub
from sentry_sdk.utils import event_from_exception
from sentry_sdk import configure_scope
with_sentry_sdk = True
except ImportError:
with_sentry_sdk = False
from PyQt5.QtCore import QT_VERSION_STR, PYQT_VERSION_STR, QUrl
from PyQt5.QtWidgets import QDialog, QDialogButtonBox, QVBoxLayout, QLabel, QTextEdit, QGroupBox, QCheckBox, QPushButton
@ -66,6 +70,7 @@ class CrashHandler:
if has_started and exception_type in skip_exception_types:
return
if with_sentry_sdk:
with configure_scope() as scope:
scope.set_tag("during_startup", not has_started)
@ -203,6 +208,7 @@ class CrashHandler:
layout.addWidget(label)
group.setLayout(layout)
if with_sentry_sdk:
with configure_scope() as scope:
scope.set_tag("qt_version", QT_VERSION_STR)
scope.set_tag("pyqt_version", PYQT_VERSION_STR)
@ -247,6 +253,7 @@ class CrashHandler:
except:
pass
if with_sentry_sdk:
with configure_scope() as scope:
scope.set_tag("opengl_version", opengl_instance.getOpenGLVersion())
scope.set_tag("gpu_vendor", opengl_instance.getGPUVendorName())
@ -335,6 +342,7 @@ class CrashHandler:
"module_name": module_name, "version": module_version, "is_plugin": isPlugin}
self.data["exception"] = exception_dict
if with_sentry_sdk:
with configure_scope() as scope:
scope.set_tag("is_plugin", isPlugin)
scope.set_tag("module", module_name)
@ -396,6 +404,7 @@ class CrashHandler:
# Before sending data, the user comments are stored
self.data["user_info"] = self.user_description_text_area.toPlainText()
if with_sentry_sdk:
try:
hub = Hub.current
event, hint = event_from_exception((self.exception_type, self.value, self.traceback))
@ -405,6 +414,14 @@ class CrashHandler:
Logger.logException("e", "An exception occurred while trying to send crash report")
if not self.has_started:
print("An exception occurred while trying to send crash report: %s" % e)
else:
msg = "SentrySDK is not available and the report could not be sent."
Logger.logException("e", msg)
if not self.has_started:
print(msg)
print("Exception type: {}".format(self.exception_type))
print("Value: {}".format(self.value))
print("Traceback: {}".format(self.traceback))
os._exit(1)

View File

@ -12,7 +12,11 @@ from UM.Platform import Platform
from cura import ApplicationMetadata
from cura.ApplicationMetadata import CuraAppName
try:
import sentry_sdk
with_sentry_sdk = True
except ImportError:
with_sentry_sdk = False
parser = argparse.ArgumentParser(prog = "cura",
add_help = False)
@ -24,6 +28,7 @@ parser.add_argument("--debug",
known_args = vars(parser.parse_known_args()[0])
if with_sentry_sdk:
sentry_env = "production"
if ApplicationMetadata.CuraVersion == "master":
sentry_env = "development"