Sentry breadcrumb logger added

Julian Kahnert · Julian Kahnert · commit d4461b809f55 · 2021-01-19T17:38:21.000+01:00
diff --git a/ArchiveCore/Package.swift b/ArchiveCore/Package.swift
@@ -28,7 +28,8 @@ let package = Package(
         .package(url: "https://github.com/WeTransfer/Diagnostics", from: "1.8.0"),
 //        .package(url: "https://github.com/tikhop/TPInAppReceipt", from: "3.0.2"),
         .package(url: "https://github.com/tikhop/TPInAppReceipt", .branch("master")),
-        .package(url: "https://github.com/shaps80/GraphicsRenderer", from: "1.4.4")
+        .package(url: "https://github.com/shaps80/GraphicsRenderer", from: "1.4.4"),
+        .package(name: "Sentry", url: "https://github.com/getsentry/sentry-cocoa", from: "6.1.3")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -56,7 +57,8 @@ let package = Package(
         .target(name: "ArchiveSharedConstants",
                 dependencies: [
                     .product(name: "Logging", package: "swift-log"),
-                    "SwiftUIX"
+                    "SwiftUIX",
+                    "Sentry"
                 ]),
         .testTarget(name: "ArchiveBackendTests",
                     dependencies: [
diff --git a/ArchiveCore/Sources/ArchiveBackend/ArchiveStore.swift b/ArchiveCore/Sources/ArchiveBackend/ArchiveStore.swift
@@ -258,7 +258,7 @@ public final class ArchiveStore: ObservableObject, ArchiveStoreAPI, Log {
         log.info("Found \(documents.count) documents.")
         self.state = .live
         DispatchQueue.global(qos: .background).async {
-            self.saveDocuments()
+            self.save(documents)
         }
     }
 
@@ -311,7 +311,7 @@ public final class ArchiveStore: ObservableObject, ArchiveStoreAPI, Log {
         }
     }
 
-    private func saveDocuments() {
+    private func save(_ documents: [Document]) {
 
         if fileManager.fileExists(atPath: Self.savePath.path) {
             try? fileManager.removeItem(at: Self.savePath)
diff --git a/ArchiveCore/Sources/ArchiveSharedConstants/Logging/SentryBreadcrumbLogger.swift b/ArchiveCore/Sources/ArchiveSharedConstants/Logging/SentryBreadcrumbLogger.swift
@@ -0,0 +1,53 @@
+//
+//  SentryBreadcrumbLogger.swift
+//  
+//
+//  Created by Julian Kahnert on 19.01.21.
+//
+
+import Logging
+import Sentry
+
+public struct SentryBreadcrumbLogger: LogHandler {
+    public var metadata: Logger.Metadata
+    public var logLevel: Logger.Level = .info
+
+    public init(metadata: Logger.Metadata, logLevel: Logger.Level = .info) {
+        self.metadata = metadata
+        self.logLevel = logLevel
+    }
+
+    public subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? {
+        get {
+            return self.metadata[metadataKey]
+        }
+        set {
+            self.metadata[metadataKey] = newValue
+        }
+    }
+
+    public func log(level: Logger.Level, message: Logger.Message, metadata: Logger.Metadata? = nil, file: String = #file, function: String = #function, line: UInt = #line) {
+        guard level >= logLevel else { return }
+
+        let sentryLevel: SentryLevel
+        switch level {
+            case .debug, .trace, .notice:
+                sentryLevel = .debug
+            case .info:
+                sentryLevel = .info
+            case .warning:
+                sentryLevel = .warning
+            case .error:
+                sentryLevel = .error
+            case .critical:
+                sentryLevel = .fatal
+        }
+
+        let crumb = Breadcrumb()
+        crumb.level = sentryLevel
+        crumb.category = "\(file) \(function):\(line)"
+        crumb.message = message.description
+        crumb.timestamp = Date()
+        SentrySDK.addBreadcrumb(crumb: crumb)
+    }
+}
diff --git a/PDFArchiver.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/PDFArchiver.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/Shared/PDFArchiverApp.swift b/Shared/PDFArchiverApp.swift
@@ -106,9 +106,11 @@ struct PDFArchiverApp: App, Log {
         }
 
         LoggingSystem.bootstrap { label in
+            let logLevel: Logger.Level = AppEnvironment.get() == .production ? .info : .trace
             var sysLogger = StreamLogHandler.standardOutput(label: label)
-            sysLogger.logLevel = AppEnvironment.get() == .production ? .info : .trace
-            return sysLogger
+            sysLogger.logLevel = logLevel
+            let sentryLogger = SentryBreadcrumbLogger(metadata: [:], logLevel: logLevel)
+            return MultiplexLogHandler([sysLogger, sentryLogger])
         }
 
         DispatchQueue.global().async {

Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ public final class ArchiveStore: ObservableObject, ArchiveStoreAPI, Log {`
`258`	`258`	`log.info("Found \(documents.count) documents.")`
`259`	`259`	`self.state = .live`
`260`	`260`	`DispatchQueue.global(qos: .background).async {`
`261`		`- self.saveDocuments()`
	`261`	`+ self.save(documents)`
`262`	`262`	`}`
`263`	`263`	`}`
`264`	`264`
`@@ -311,7 +311,7 @@ public final class ArchiveStore: ObservableObject, ArchiveStoreAPI, Log {`
`311`	`311`	`}`
`312`	`312`	`}`
`313`	`313`
`314`		`- private func saveDocuments() {`
	`314`	`+ private func save(_ documents: [Document]) {`
`315`	`315`
`316`	`316`	`if fileManager.fileExists(atPath: Self.savePath.path) {`
`317`	`317`	`try? fileManager.removeItem(at: Self.savePath)`
Original file line number	Diff line number	Diff line change
`@@ -106,9 +106,11 @@ struct PDFArchiverApp: App, Log {`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`LoggingSystem.bootstrap { label in`
	`109`	`+ let logLevel: Logger.Level = AppEnvironment.get() == .production ? .info : .trace`
`109`	`110`	`var sysLogger = StreamLogHandler.standardOutput(label: label)`
`110`		`- sysLogger.logLevel = AppEnvironment.get() == .production ? .info : .trace`
`111`		`- return sysLogger`
	`111`	`+ sysLogger.logLevel = logLevel`
	`112`	`+ let sentryLogger = SentryBreadcrumbLogger(metadata: [:], logLevel: logLevel)`
	`113`	`+ return MultiplexLogHandler([sysLogger, sentryLogger])`
`112`	`114`	`}`
`113`	`115`
`114`	`116`	`DispatchQueue.global().async {`