Structured Logs: Move options out of experimental (#6359)

Author: denrase

.github/workflows/test-cross-platform.yml

@@ -55,7 +55,7 @@ jobs:
         with:
           repository: getsentry/sentry-react-native
           path: sentry-react-native
-          ref: removeEnableTracing
+          ref: denrase/options-enable-logs
 
       - name: Enable Corepack
         working-directory: sentry-react-native

CHANGELOG.md

@@ -13,6 +13,7 @@
 - Removes deprecated user feedback API, this is replaced with the new feedback API (#5591)
 - Removes `enablePerformanceV2` option and makes this the default. The app start duration will now finish when the first frame is drawn instead of when the OS posts the UIWindowDidBecomeVisibleNotification. (#6008)
 - Removes enableTracing property from SentryOptions (#5694)
+- Structured Logs: Move options out of experimental (#6359)
 
 ### Features
 

Samples/SentrySampleShared/SentrySampleShared/SentrySDKWrapper.swift

@@ -161,10 +161,11 @@ public struct SentrySDKWrapper {
         }
 #endif // !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)
 
+        options.enableLogs = true
+
         // Experimental features
         options.experimental.enableFileManagerSwizzling = !SentrySDKOverrides.Other.disableFileManagerSwizzling.boolValue
         options.experimental.enableUnhandledCPPExceptionsV2 = true
-        options.experimental.enableLogs = true
     }
 
     func configureInitialScope(scope: Scope, options: Options) -> Scope {

Sources/Sentry/Public/SentryOptions.h

@@ -157,6 +157,13 @@ NS_SWIFT_NAME(Options)
  */
 @property (nullable, nonatomic, copy) SentryBeforeSendSpanCallback beforeSendSpan NS_SWIFT_SENDABLE;
 
+/**
+ * When enabled, the SDK sends logs to Sentry. Logs can be captured using the @c SentrySDK.logger
+ * API, which provides structured logging with attributes.
+ * @note Default value is @c NO .
+ */
+@property (nonatomic, assign) BOOL enableLogs;
+
 #if !SWIFT_PACKAGE
 /**
  * Use this callback to drop or modify a log before the SDK sends it to Sentry. Return @c nil to

Sources/Sentry/SentryOptions.m

@@ -117,6 +117,7 @@ - (instancetype)init
         self.enableNetworkTracking = YES;
         self.enableFileIOTracing = YES;
         self.enableNetworkBreadcrumbs = YES;
+        self.enableLogs = NO;
         self.tracesSampleRate = nil;
 #if SENTRY_TARGET_PROFILING_SUPPORTED
 #    if !SDK_V9

Sources/Sentry/SentyOptionsInternal.m

@@ -155,6 +155,8 @@ + (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
         sentryOptions.maxBreadcrumbs = [options[@"maxBreadcrumbs"] unsignedIntValue];
     }
 
+    [self setBool:options[@"enableLogs"] block:^(BOOL value) { sentryOptions.enableLogs = value; }];
+
     [self setBool:options[@"enableNetworkBreadcrumbs"]
             block:^(BOOL value) { sentryOptions.enableNetworkBreadcrumbs = value; }];
 
@@ -172,6 +174,12 @@ + (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
         sentryOptions.beforeSend = options[@"beforeSend"];
     }
 
+#if !SWIFT_PACKAGE
+    if ([self isBlock:options[@"beforeSendLog"]]) {
+        sentryOptions.beforeSendLog = options[@"beforeSendLog"];
+    }
+#endif // !SWIFT_PACKAGE
+
     if ([self isBlock:options[@"beforeSendSpan"]]) {
         sentryOptions.beforeSendSpan = options[@"beforeSendSpan"];
     }

Sources/Swift/Helper/SentrySDK.swift

@@ -37,7 +37,7 @@ import Foundation
             }
             let hub = SentryDependencyContainerSwiftHelper.currentHub()
             var batcher: SentryLogBatcher?
-            if let client = hub.getClient(), client.options.experimental.enableLogs {
+            if let client = hub.getClient(), client.options.enableLogs {
                 batcher = SentryLogBatcher(client: client, dispatchQueue: Dependencies.dispatchQueueWrapper)
             }
             let logger = SentryLogger(

Sources/Swift/SentryExperimentalOptions.swift

@@ -30,7 +30,7 @@ public final class SentryExperimentalOptions: NSObject {
      * - Experiment: This is an experimental feature and is therefore disabled by default. We'll enable it by default in a future major release.
      */
     public var enableUnhandledCPPExceptionsV2 = false
-
+    
     /**
      * Forces enabling of session replay in unreliable environments.
      *
@@ -48,11 +48,6 @@ public final class SentryExperimentalOptions: NSObject {
      */
     public var enableSessionReplayInUnreliableEnvironment = false
 
-    /**
-     * Logs are considered beta.
-     */
-    public var enableLogs = false
-
     @_spi(Private) public func validateOptions(_ options: [String: Any]?) {
     }
 }

Tests/SentryTests/SentryLogBatcherTests.swift

@@ -14,7 +14,7 @@ final class SentryLogBatcherTests: XCTestCase {
         super.setUp()
 
         options = Options()
-        options.experimental.enableLogs = true
+        options.enableLogs = true
 
         testClient = TestClient(options: options)
         testDispatchQueue = TestSentryDispatchQueueWrapper()

Tests/SentryTests/SentryLoggerTests.swift

@@ -311,7 +311,7 @@ final class SentryLoggerTests: XCTestCase {
     }
 
     func testCaptureLog_SetsTraceIdFromPropagationContext() {
-        fixture.options.experimental.enableLogs = true
+        fixture.options.enableLogs = true
 
         let expectedTraceId = SentryId()
         let propagationContext = SentryPropagationContext(trace: expectedTraceId, spanId: SpanId())