Structured Logs: Add SentrySwiftLog Integration (#6286)

Author: denrase

.github/actions/prepare-package.swift/action.yml

@@ -43,9 +43,14 @@ runs:
       env:
         PACKAGE_FILE: ${{ inputs.package-file }}
       run: |
-        sed -i '' 's/url.*//g' $PACKAGE_FILE
+        # Remove Sentry binary framework URLs and convert checksums to paths
+        sed -i '' 's/url: "https:\/\/github\.com\/getsentry\/sentry-cocoa\/releases\/download\/.*"//g' $PACKAGE_FILE
         sed -i '' 's/checksum: ".*" \/\/Sentry-Static/path: "Sentry.xcframework.zip"/g' $PACKAGE_FILE
         sed -i '' 's/checksum: ".*" \/\/Sentry-Dynamic-WithARM64e/path: "Sentry-Dynamic-WithARM64e.xcframework.zip"/g' $PACKAGE_FILE
         sed -i '' 's/checksum: ".*" \/\/Sentry-Dynamic/path: "Sentry-Dynamic.xcframework.zip"/g' $PACKAGE_FILE
         sed -i '' 's/checksum: ".*" \/\/Sentry-WithoutUIKitOrAppKit-WithARM64e/path: "Sentry-WithoutUIKitOrAppKit-WithARM64e.xcframework.zip"/g' $PACKAGE_FILE
         sed -i '' 's/checksum: ".*" \/\/Sentry-WithoutUIKitOrAppKit/path: "Sentry-WithoutUIKitOrAppKit.xcframework.zip"/g' $PACKAGE_FILE
+        # Clean up orphaned commas and fix syntax
+        sed -i '' '/^[[:space:]]*,$/d' $PACKAGE_FILE
+        sed -i '' 's/name: "Sentry\(-.*\)\?"$/name: "Sentry\1",/g' $PACKAGE_FILE
+        sed -i '' 's/platforms: \[\.iOS(\.v11), \.macOS(\.v10_13), \.tvOS(\.v11), \.watchOS(\.v4)\]$/platforms: [.iOS(.v11), .macOS(.v10_13), .tvOS(.v11), .watchOS(.v4)],/g' $PACKAGE_FILE

.github/workflows/test.yml

@@ -330,6 +330,16 @@ jobs:
             device: "iPhone 15 Pro"
             scheme: "SentrySwiftUI"
 
+          # iOS 17 - Use pre-installed iOS 17.5 runtime on macOS-14 with Xcode 15.4
+          - name: iOS 17 SentrySwiftLog
+            runs-on: macos-14
+            xcode: "15.4"
+            test-destination-os: "17.5"
+            platform: "iOS"
+            create_device: true
+            device: "iPhone 15 Pro"
+            scheme: "SentrySwiftLog"
+
           # tvOS 18
           - name: tvOS 18 Sentry
             runs-on: macos-15

CHANGELOG.md

@@ -47,6 +47,7 @@
   This option is still disabled by default and will be enabled in a future major release.
 - Move `enableDataSwizzling` from experimental options to top-level options (#6592). This option remains enabled by default.
 - Add `sentry.replay_id` attribute to logs ([#6515](https://github.com/getsentry/sentry-cocoa/pull/6515))
+- Structured Logs: Add `SentrySwiftLog` Integration (#6286)
 
 ### Fixes
 

Package.swift

@@ -16,7 +16,8 @@ var products: [Product] = [
     .library(name: "Sentry-WithoutUIKitOrAppKit", targets: ["Sentry-WithoutUIKitOrAppKit", "SentryCppHelper"]),
     .library(name: "Sentry-WithoutUIKitOrAppKit-WithARM64e", targets: ["Sentry-WithoutUIKitOrAppKit-WithARM64e", "SentryCppHelper"]),
     .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI", "SentryCppHelper"]),
-    .library(name: "SentryDistribution", targets: ["SentryDistribution"])
+    .library(name: "SentryDistribution", targets: ["SentryDistribution"]),
+    .library(name: "SentrySwiftLog", targets: ["Sentry", "SentrySwiftLog"])
 ]
 
 var targets: [Target] = [
@@ -45,21 +46,31 @@ var targets: [Target] = [
         url: "https://github.com/getsentry/sentry-cocoa/releases/download/8.57.1/Sentry-WithoutUIKitOrAppKit-WithARM64e.xcframework.zip",
         checksum: "6f3b991969a02f02878d052d0edf7076110f0ea577f84b2c5ad706a9bd302c54" //Sentry-WithoutUIKitOrAppKit-WithARM64e
     ),
-    .target (
+    .target(
         name: "SentrySwiftUI",
         dependencies: ["Sentry", "SentryInternal"],
         path: "Sources/SentrySwiftUI",
         exclude: ["SentryInternal/", "module.modulemap"],
         linkerSettings: [
             .linkedFramework("Sentry")
-        ]),
+        ]
+    ),
+    .target(
+        name: "SentrySwiftLog",
+        dependencies: ["Sentry", .product(name: "Logging", package: "swift-log")],
+        path: "Sources/SentrySwiftLog",
+        linkerSettings: [
+            .linkedFramework("Sentry")
+        ]
+    ),
     .target(
         name: "SentryInternal",
         path: "Sources/SentrySwiftUI",
         sources: [
             "SentryInternal/"
         ],
-        publicHeadersPath: "SentryInternal/"),
+        publicHeadersPath: "SentryInternal/"
+    ),
     .target(
         name: "SentryCppHelper",
         dependencies: ["Sentry"],
@@ -101,7 +112,7 @@ if let env = env, String(cString: env, encoding: .utf8) == "1" {
             name: "SentryObjc",
             dependencies: ["SentrySwift"],
             path: "Sources",
-            exclude: ["Sentry/SentryDummyPublicEmptyClass.m", "Sentry/SentryDummyPrivateEmptyClass.m", "Swift", "SentrySwiftUI", "Resources", "Configuration", "SentryCppHelper", "SentryDistribution", "SentryDistributionTests"],
+            exclude: ["Sentry/SentryDummyPublicEmptyClass.m", "Sentry/SentryDummyPrivateEmptyClass.m", "Swift", "SentrySwiftUI", "SentrySwiftLog", "Resources", "Configuration", "SentryCppHelper", "SentryDistribution", "SentryDistributionTests"],
             cSettings: [
                 .headerSearchPath("Sentry/include/HybridPublic"),
                 .headerSearchPath("Sentry"),
@@ -118,6 +129,12 @@ let package = Package(
     name: "Sentry",
     platforms: [.iOS(.v15), .macOS(.v12), .tvOS(.v15), .watchOS(.v8)],
     products: products,
+    dependencies: [
+        // SPM doesn't support peer-dependencies, so users are locked into our declared version.
+        // Using `from: "1.6.0"` covers 1.6.0 < 2.0.0, resolving minor versions automatically.
+        // See develop-docs/DECISIONS.md for discussion.
+        .package(url: "https://github.com/apple/swift-log", from: "1.6.0")
+    ],
     targets: targets,
     cxxLanguageStandard: .cxx14
 )

Plans/SentrySwiftLog_Base.xctestplan

@@ -0,0 +1,24 @@
+{
+  "configurations" : [
+    {
+      "id" : "EBB4F92C-3CA9-47E0-8589-7934881F1E4B",
+      "name" : "Configuration 1",
+      "options" : {
+
+      }
+    }
+  ],
+  "defaultOptions" : {
+    "codeCoverage" : true
+  },
+  "testTargets" : [
+    {
+      "target" : {
+        "containerPath" : "container:Sentry.xcodeproj",
+        "identifier" : "9241AC1A2EBA38CC00E611ED",
+        "name" : "SentrySwiftLogTests"
+      }
+    }
+  ],
+  "version" : 1
+}

Samples/iOS-Swift/iOS-Swift.yml

@@ -32,6 +32,7 @@ targets:
       - target: iOS-SwiftClip
       - target: SentrySampleShared/SentrySampleShared
       - target: iOS-Swift-ShareExtension
+      - target: Sentry/SentrySwiftLog
     configFiles:
       Debug: iOS-Swift.xcconfig
       Release: iOS-Swift.xcconfig

Samples/iOS-Swift/iOS-Swift/AppDelegate.swift

@@ -1,6 +1,9 @@
 import SentrySampleShared
 import UIKit
 
+import Logging
+import SentrySwiftLog
+
 @UIApplicationMain
 class AppDelegate: UIResponder, UIApplicationDelegate {
     private var randomDistributionTimer: Timer?
@@ -24,11 +27,22 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
         SentrySDKWrapper.shared.startSentry()
         SampleAppDebugMenu.shared.display()
-
+        
         if #available(iOS 15.0, *) {
             metricKit.receiveReports()
         }
 
+        // Use structured logs with swift-log
+        LoggingSystem.bootstrap { _ in
+            return SentryLogHandler(logLevel: .trace)
+        }
+        let logger = Logger(label: "io.sentry.iOS-Swift")
+        logger.trace(
+            "[iOS-Swift] didFinishLaunchingWithOptions",
+            metadata: ["foo": "bar"],
+            source: "iOS"
+        )
+        
         return true
     }
 

Samples/iOS15-SwiftUI/iOS15-SwiftUI/ContentView.swift

@@ -8,7 +8,6 @@ struct ContentView: View {
             await captureErrorAsync()
         }
     }
-    
     func captureErrorAsync() async {
         let error = NSError(domain: "SampleErrorDomain", code: 1, userInfo: [NSLocalizedDescriptionKey: "Object does not exist"])
         SentrySDK.capture(error: error)