Add classes.sentry to manage sentry_sdk

Author: ferdnyc

src/classes/sentry.py

@@ -0,0 +1,91 @@
+"""
+ @file
+ @brief This file manages the optional Sentry SDK
+ @author Jonathan Thomas <[email protected]>
+ @author FeRD (Frank Dana) <[email protected]>
+
+ @section LICENSE
+
+ Copyright (c) 2008-2021 OpenShot Studios, LLC
+ (http://www.openshotstudios.com). This file is part of
+ OpenShot Video Editor (http://www.openshot.org), an open-source project
+ dedicated to delivering high quality video editing and animation solutions
+ to the world.
+
+ OpenShot Video Editor is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ OpenShot Video Editor is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
+ """
+
+import platform
+
+from classes import info
+
+try:
+    import distro
+except ModuleNotFoundError:
+    distro = None
+
+try:
+    import sentry_sdk as sdk
+except ModuleNotFoundError:
+    sdk = None
+
+
+def init_tracing():
+    """Init all Sentry tracing"""
+    if not sdk:
+        return
+
+    # Determine sample rate for exceptions
+    traces_sample_rate = 0.1
+    environment = "production"
+    if "-dev" in info.VERSION:
+        # Dev mode, trace all exceptions
+        traces_sample_rate = 1.0
+        environment = "development"
+
+    # Initialize sentry exception tracing
+    sdk.init(
+        "https://[email protected]/5795985",
+        traces_sample_rate=traces_sample_rate,
+        release=f"openshot@{info.VERSION}",
+        environment=environment
+    )
+    sdk.set_tag("system", platform.system())
+    sdk.set_tag("machine", platform.machine())
+    sdk.set_tag("processor", platform.processor())
+    sdk.set_tag("platform", platform.platform())
+    if distro:
+        sdk.set_tag("distro", " ".join(distro.linux_distribution()))
+    sdk.set_tag("locale", info.CURRENT_LANGUAGE)
+
+
+def disable_tracing():
+    """Disable all Sentry tracing requests"""
+    if sdk:
+        sdk.init()
+
+
+def set_tag(*args):
+    if sdk:
+        sdk.set_tag(*args)
+
+
+def set_user(*args):
+    if sdk:
+        sdk.set_user(*args)
+
+
+def set_context(*args):
+    if sdk:
+        sdk.set_context(*args)