[Structured Logging] Add SentryLog Models

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 - Capturing fatal CPPExceptions via hooking into cxa_throw when enabling `options.experimental.enableUnhandledCPPExceptionsV2 = true` (#5256)
+- [Structured Logging] Models + Preparation ([#5441](https://github.com/getsentry/sentry-cocoa/pull/5441))
 
 ### Fixes
 

SentryTestUtils/ClearTestState.swift

@@ -31,7 +31,7 @@ class TestCleanup: NSObject {
         PrivateSentrySDKOnly.appStartMeasurementHybridSDKMode = false
         SentryNetworkTracker.sharedInstance.disable()
 
-        SentryLog.setDefaultTestLogConfiguration()
+        SentryLogSwift.setDefaultTestLogConfiguration()
 
         #if os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
 

SentryTestUtils/SentryLogExtensions.swift

@@ -1,17 +1,17 @@
 import Foundation
 @_spi(Private) @testable import Sentry
 
-extension SentryLog {
+extension SentryLogSwift {
 
     public static func setDefaultTestLogConfiguration() {
-        SentryLog._configure(false, diagnosticLevel: .error)
+        SentryLogSwift._configure(false, diagnosticLevel: .error)
     }
 
     /// SentryLog uses NSLog internally, which can significantly slow down code because it requires
     /// synchronization. Use this method sparingly for individual test cases.
     public static func withDebugLogs<T>(_ closure: () throws -> T) rethrows -> T {
         defer { setDefaultTestLogConfiguration() }
-        SentryLog._configure(true, diagnosticLevel: .debug)
+        SentryLogSwift._configure(true, diagnosticLevel: .debug)
         return try closure()
     }
 

SentryTestUtils/SentryTestUtils-ObjC-BridgingHeader.h

@@ -44,7 +44,7 @@
 #import "SentryGlobalEventProcessor.h"
 #import "SentryHub+Private.h"
 #import "SentryHub+Test.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryNSNotificationCenterWrapper.h"
 #import "SentryNSProcessInfoWrapper.h"
 #import "SentryNSTimerFactory.h"

Sources/Sentry/Processors/SentryWatchdogTerminationBreadcrumbProcessor.m

@@ -1,6 +1,6 @@
 #import "SentryWatchdogTerminationBreadcrumbProcessor.h"
 #import "SentryFileManager.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentrySerialization.h"
 
 @interface SentryWatchdogTerminationBreadcrumbProcessor ()

Sources/Sentry/Profiling/SentryContinuousProfiler.mm

@@ -4,7 +4,7 @@
 
 #    import "SentryDependencyContainer.h"
 #    import "SentryDispatchQueueWrapper.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryMetricProfiler.h"
 #    import "SentryNSNotificationCenterWrapper.h"
 #    import "SentryNSTimerFactory.h"

Sources/Sentry/Profiling/SentryLaunchProfiling.m

@@ -8,7 +8,7 @@
 #    import "SentryFileManager.h"
 #    import "SentryInternalDefines.h"
 #    import "SentryLaunchProfiling.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryOptions+Private.h"
 #    import "SentryProfiler+Private.h"
 #    import "SentryRandom.h"

Sources/Sentry/Profiling/SentryProfiledTracerConcurrency.mm

@@ -4,7 +4,7 @@
 
 #    import "SentryContinuousProfiler.h"
 #    import "SentryInternalDefines.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryOptions+Private.h"
 #    import "SentryProfiler+Private.h"
 #    import "SentrySwift.h"
@@ -16,7 +16,7 @@
 #    import "SentryHub+Private.h"
 #    import "SentryInternalDefines.h"
 #    import "SentryLaunchProfiling.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryOptions+Private.h"
 #    import "SentryProfiledTracerConcurrency.h"
 #    import "SentryProfiler+Private.h"

Sources/Sentry/Profiling/SentryProfilerSerialization.mm

@@ -13,7 +13,7 @@
 #    import "SentryEvent+Private.h"
 #    import "SentryFormatter.h"
 #    import "SentryInternalDefines.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryMeta.h"
 #    import "SentryMetricProfiler.h"
 #    import "SentryProfileTimeseries.h"

Sources/Sentry/Profiling/SentryTraceProfiler.mm

@@ -4,7 +4,7 @@
 
 #    import "SentryDependencyContainer.h"
 #    import "SentryDispatchQueueWrapper.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryMetricProfiler.h"
 #    import "SentryNSTimerFactory.h"
 #    import "SentryProfiledTracerConcurrency.h"

Sources/Sentry/Public/SentryDefines.h

@@ -171,16 +171,6 @@ typedef NSNumber *_Nullable (^SentryTracesSamplerCallback)(
 typedef void (^SentrySpanCallback)(id<SentrySpan> _Nullable span DEPRECATED_MSG_ATTRIBUTE(
     "See `SentryScope.useSpan` for reasoning of deprecation."));
 
-/**
- * Log level.
- */
-typedef NS_ENUM(NSInteger, SentryLogLevel) {
-    kSentryLogLevelNone = 1,
-    kSentryLogLevelError,
-    kSentryLogLevelDebug,
-    kSentryLogLevelVerbose
-};
-
 /**
  * Sentry level.
  */

Sources/Sentry/SentryANRTrackerV1.m

@@ -2,7 +2,7 @@
 #import "SentryCrashWrapper.h"
 #import "SentryDependencyContainer.h"
 #import "SentryDispatchQueueWrapper.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentrySwift.h"
 #import "SentryThreadWrapper.h"
 #import <stdatomic.h>

Sources/Sentry/SentryANRTrackerV2.m

@@ -6,7 +6,7 @@
 #    import "SentryDependencyContainer.h"
 #    import "SentryDispatchQueueWrapper.h"
 #    import "SentryFramesTracker.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentrySwift.h"
 #    import "SentryThreadWrapper.h"
 #    import "SentryTime.h"

Sources/Sentry/SentryANRTrackingIntegration.m

@@ -8,7 +8,7 @@
 #import "SentryException.h"
 #import "SentryFileManager.h"
 #import "SentryHub+Private.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryMechanism.h"
 #import "SentrySDK+Private.h"
 #import "SentryScope+Private.h"

Sources/Sentry/SentryAppStartMeasurement.m

@@ -3,7 +3,7 @@
 #if SENTRY_UIKIT_AVAILABLE
 
 #    import "SentryDateUtils.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 
 @implementation SentryAppStartTypeToString
 + (NSString *)convert:(SentryAppStartType)type

Sources/Sentry/SentryAppStartTracker.m

@@ -6,14 +6,14 @@
 #    import "SentryAppStateManager.h"
 #    import "SentryDefines.h"
 #    import "SentryFramesTracker.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentrySysctl.h"
 #    import <PrivateSentrySDKOnly.h>
 #    import <SentryAppState.h>
 #    import <SentryDependencyContainer.h>
 #    import <SentryDispatchQueueWrapper.h>
 #    import <SentryInternalNotificationNames.h>
-#    import <SentryLog.h>
+#    import <SentryLogC.h>
 #    import <SentrySDK+Private.h>
 #    import <SentrySwift.h>
 #    import <UIKit/UIKit.h>

Sources/Sentry/SentryAppStartTrackingIntegration.m

@@ -3,7 +3,7 @@
 #if SENTRY_HAS_UIKIT
 
 #    import "SentryAppStartTracker.h"
-#    import "SentryLog.h"
+#    import "SentryLogC.h"
 #    import "SentryOptions.h"
 #    import <PrivateSentrySDKOnly.h>
 #    import <SentryAppStateManager.h>

Sources/Sentry/SentryAsyncLog.h

@@ -0,0 +1,24 @@
+#ifndef SentryAsyncLog_h
+#define SentryAsyncLog_h
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Wrapper for initializing async-safe logging functionality.
+ * This is used for crash-safe logging that can write to a file even during crashes.
+ */
+@interface SentryAsyncLogWrapper : NSObject
+
+/**
+ * Initializes the async log file in the Sentry cache directory.
+ * This method sets up async-safe logging that can be used during crash scenarios.
+ */
++ (void)initializeAsyncLogFile;
+
+@end
+
+NS_ASSUME_NONNULL_END
+
+#endif // SentryAsyncLog_h 

Sources/Sentry/SentryAsyncLog.m

@@ -0,0 +1,32 @@
+#import "SentryAsyncLog.h"
+#import "SentryAsyncSafeLog.h"
+#import "SentryFileManager.h"
+#import "SentryInternalCDefines.h"
+#import "SentryLogC.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@implementation SentryAsyncLogWrapper
+
++ (void)initializeAsyncLogFile
+{
+    const char *asyncLogPath =
+        [[sentryStaticCachesPath() stringByAppendingPathComponent:@"async.log"] UTF8String];
+
+    NSError *error;
+    if (!createDirectoryIfNotExists(sentryStaticCachesPath(), &error)) {
+        SENTRY_LOG_ERROR(@"Failed to initialize directory for async log file: %@", error);
+        return;
+    }
+
+    if (SENTRY_LOG_ERRNO(
+            sentry_asyncLogSetFileName(asyncLogPath, true /* overwrite existing log */))
+        != 0) {
+        SENTRY_LOG_ERROR(
+            @"Could not open a handle to specified path for async logging %s", asyncLogPath);
+    };
+}
+
+@end
+
+NS_ASSUME_NONNULL_END 

Sources/Sentry/SentryAutoBreadcrumbTrackingIntegration.m

@@ -2,7 +2,7 @@
 #import "SentryBreadcrumbTracker.h"
 #import "SentryDependencyContainer.h"
 #import "SentryFileManager.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryOptions.h"
 #import "SentrySDK.h"
 #import "SentrySystemEventBreadcrumbs.h"

Sources/Sentry/SentryAutoSessionTrackingIntegration.m

@@ -1,6 +1,6 @@
 #import "SentryAutoSessionTrackingIntegration.h"
 #import "SentryDependencyContainer.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryOptions.h"
 #import "SentrySDK.h"
 #import "SentrySessionTracker.h"

Sources/Sentry/SentryBaggage.m

@@ -1,6 +1,6 @@
 #import "SentryBaggage.h"
 #import "SentryDsn.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryOptions+Private.h"
 #import "SentryScope+Private.h"
 #import "SentrySwift.h"

Sources/Sentry/SentryBaseIntegration.m

@@ -1,6 +1,6 @@
 #import "SentryBaseIntegration.h"
 #import "SentryCrashWrapper.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentrySwift.h"
 #import <SentryDependencyContainer.h>
 #import <SentryOptions+Private.h>

Sources/Sentry/SentryBinaryImageCache.m

@@ -3,7 +3,7 @@
 #include "SentryCrashUUIDConversion.h"
 #import "SentryDependencyContainer.h"
 #import "SentryInAppLogic.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Sources/Sentry/SentryBreadcrumbTracker.m

@@ -5,7 +5,7 @@
 #import "SentryDefines.h"
 #import "SentryDependencyContainer.h"
 #import "SentryHub.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryReachability.h"
 #import "SentryScope.h"
 #import "SentrySwift.h"

Sources/Sentry/SentryClient.m

@@ -20,7 +20,7 @@
 #import "SentryHub.h"
 #import "SentryInAppLogic.h"
 #import "SentryInstallation.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryMechanism.h"
 #import "SentryMechanismMeta.h"
 #import "SentryMessage.h"

Sources/Sentry/SentryCoreDataTracker.m

@@ -3,7 +3,7 @@
 #import "SentryFrame.h"
 #import "SentryHub+Private.h"
 #import "SentryInternalDefines.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryNSProcessInfoWrapper.h"
 #import "SentryPredicateDescriptor.h"
 #import "SentrySDK+Private.h"

Sources/Sentry/SentryCoreDataTrackingIntegration.m

@@ -2,7 +2,7 @@
 #import "SentryCoreDataSwizzling.h"
 #import "SentryCoreDataTracker.h"
 #import "SentryDependencyContainer.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryNSDataSwizzling.h"
 #import "SentryNSProcessInfoWrapper.h"
 #import "SentryOptions.h"

Sources/Sentry/SentryCrashInstallationReporter.m

@@ -3,7 +3,7 @@
 #import "SentryCrashInstallation+Private.h"
 #import "SentryCrashReportSink.h"
 #import "SentryDefines.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

Sources/Sentry/SentryCrashIntegration.m

@@ -21,7 +21,7 @@
 #import <SentryClient+Private.h>
 #import <SentryCrashScopeObserver.h>
 #import <SentryDependencyContainer.h>
-#import <SentryLog.h>
+#import <SentryLogC.h>
 #import <SentrySDK+Private.h>
 
 #if SENTRY_HAS_UIKIT

Sources/Sentry/SentryCrashIntegrationSessionHandler.m

@@ -4,7 +4,7 @@
 #import "SentryDependencyContainer.h"
 #import "SentryFileManager.h"
 #import "SentryHub.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentrySDK+Private.h"
 #import "SentrySession.h"
 #import "SentrySwift.h"

Sources/Sentry/SentryCrashReportConverter.m

@@ -10,7 +10,7 @@
 #import "SentryFrame.h"
 #import "SentryInAppLogic.h"
 #import "SentryInternalDefines.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryMechanism.h"
 #import "SentryMechanismMeta.h"
 #import "SentryStacktrace.h"

Sources/Sentry/SentryCrashReportSink.m

@@ -10,7 +10,7 @@
 #import "SentryEvent.h"
 #import "SentryException.h"
 #import "SentryHub.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentrySDK+Private.h"
 #import "SentrySDK.h"
 #import "SentryScope+Private.h"

Sources/Sentry/SentryCrashScopeObserver.m

@@ -4,7 +4,7 @@
 #import <SentryCrashJSONCodec.h>
 #import <SentryCrashJSONCodecObjC.h>
 #import <SentryCrashScopeObserver.h>
-#import <SentryLog.h>
+#import <SentryLogC.h>
 #import <SentryNSDataUtils.h>
 #import <SentryScopeSyncC.h>
 #import <SentryUser.h>

Sources/Sentry/SentryDebugImageProvider.m

@@ -8,7 +8,7 @@
 #import "SentryFormatter.h"
 #import "SentryFrame.h"
 #import "SentryInternalDefines.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryStacktrace.h"
 #import "SentryThread.h"
 #import <Foundation/Foundation.h>

Sources/Sentry/SentryDefaultRateLimits.m

@@ -2,7 +2,7 @@
 #import "SentryConcurrentRateLimitsDictionary.h"
 #import "SentryDataCategoryMapper.h"
 #import "SentryDateUtil.h"
-#import "SentryLog.h"
+#import "SentryLogC.h"
 #import "SentryRateLimitParser.h"
 #import "SentryRetryAfterHeaderParser.h"
 #import "SentrySwift.h"