Track non-fatal issues via analytics

2026-04-22 01:22:46 +02:00 · 2022-06-15 17:43:52 +01:00
parent ffbf2abbd7
commit 34fad3ddbc
4 changed files with 90 additions and 3 deletions
@@ -0,0 +1,67 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+import Sentry
+import MatrixSDK
+
+/// Sentry client used as part of the Analytics set of tools to track health metrics
+/// of the application, such as crashes, non-fatal issues and performance.
+///
+/// All analytics tracking, incl. health metrics, is subject to user consent,
+/// configurable in user settings.
+struct SentryMonitoringClient {
+    private static let sentryDSN = "https://a5e37731f9b94642a1b93093cacbee4c@sentry.tools.element.io/47"
+    
+    func start() {
+        guard !SentrySDK.isEnabled else { return }
+        
+        MXLog.debug("[SentryMonitoringClient] Started")
+        SentrySDK.start { options in
+            options.dsn = Self.sentryDSN
+            options.tracesSampleRate = 1.0
+            
+            options.beforeSend = { event in
+                MXLog.error("[SentryMonitoringClient] Issue detected: \(event)")
+                return event
+            }
+
+            options.onCrashedLastRun = { event in
+                MXLog.debug("[SentryMonitoringClient] Last run crashed: \(event)")
+            }
+        }
+    }
+    
+    func stop() {
+        MXLog.debug("[SentryMonitoringClient] Stopped")
+        SentrySDK.close()
+    }
+    
+    func reset() {
+        MXLog.debug("[SentryMonitoringClient] Reset")
+        SentrySDK.startSession()
+    }
+    
+    func trackNonFatalIssue(_ issue: String, details: [String: Any]?) {
+        guard SentrySDK.isEnabled else { return }
+        
+        let event = Event()
+        event.level = .error
+        event.message = .init(formatted: issue)
+        event.extra = details
+        SentrySDK.capture(event: event)
+    }
+}