impr: Add extra logs for UIViewControllerSwizzling

Add more log messages for potential troubleshooting for swizzling
UIViewControllers.

CHANGELOG.md

@@ -17,6 +17,7 @@
 - Expose `SentrySessionReplayIntegration-Hybrid.h` as `private` (#4486)
 - Add `maskedViewClasses` and `unmaskedViewClasses` to SentryReplayOptions init via dict (#4492)
 - Add `quality` to SentryReplayOptions init via dict (#4495)
+- Add extra logs for UIViewControllerSwizzling (#4511)
 
 ### Fixes
 

Sources/Sentry/SentrySubClassFinder.m

@@ -36,6 +36,8 @@ - (instancetype)initWithDispatchQueue:(SentryDispatchQueueWrapper *)dispatchQueu
 - (void)actOnSubclassesOfViewControllerInImage:(NSString *)imageName block:(void (^)(Class))block;
 {
     [self.dispatchQueue dispatchAsyncWithBlock:^{
+        SENTRY_LOG_DEBUG(@"ActOnSubclassesOfViewControllerInImage: %@", imageName);
+
         Class viewControllerClass = [UIViewController class];
         if (viewControllerClass == nil) {
             SENTRY_LOG_DEBUG(@"UIViewController class not found.");
@@ -85,11 +87,9 @@ - (void)actOnSubclassesOfViewControllerInImage:(NSString *)imageName block:(void
                 block(NSClassFromString(className));
             }
 
-            [SentryLog
-                logWithMessage:[NSString stringWithFormat:@"The following UIViewControllers will "
-                                                          @"generate automatic transactions: %@",
-                                   [classesToSwizzle componentsJoinedByString:@", "]]
-                      andLevel:kSentryLevelDebug];
+            SENTRY_LOG_DEBUG(
+                @"The following UIViewControllers will generate automatic transactions: %@",
+                [classesToSwizzle componentsJoinedByString:@", "]);
         }];
     }];
 }

Sources/Sentry/SentryUIViewControllerSwizzling.m

@@ -291,16 +291,24 @@ - (void)swizzleRootViewControllerAndDescendant:(UIViewController *)rootViewContr
     NSArray<UIViewController *> *allViewControllers =
         [SentryViewController descendantsOfViewController:rootViewController];
 
+    SENTRY_LOG_DEBUG(@"Found %lu descendants for RootViewController %@", allViewControllers.count,
+        rootViewController.description);
+
     for (UIViewController *viewController in allViewControllers) {
         Class viewControllerClass = [viewController class];
         if (viewControllerClass != nil) {
-            SENTRY_LOG_DEBUG(@"UIViewControllerSwizzling Calling swizzleRootViewController.");
+            SENTRY_LOG_DEBUG(
+                @"Calling swizzleRootViewController for %@", viewController.description);
+
             [self swizzleViewControllerSubClass:viewControllerClass];
 
             // We can't get the image name with the app delegate class for some apps. Therefore, we
             // use the rootViewController and its subclasses as a fallback.  The following method
             // ensures we don't swizzle ViewControllers of UIKit.
             [self swizzleUIViewControllersOfClassesInImageOf:viewControllerClass];
+        } else {
+            SENTRY_LOG_WARN(@"ViewControllerClass was nil for UIViewController: %@",
+                viewController.description);
         }
     }
 }
@@ -325,8 +333,10 @@ - (void)swizzleUIViewController
 
 - (void)swizzleViewControllerSubClass:(Class)class
 {
-    if (![self shouldSwizzleViewController:class])
+    if (![self shouldSwizzleViewController:class]) {
+        SENTRY_LOG_DEBUG(@"Skipping swizzling of class: %@", class);
         return;
+    }
 
     // This are the five main functions related to UI creation in a view controller.
     // We are swizzling it to track anything that happens inside one of this functions.

Sources/Swift/Integrations/Performance/SwizzleClassNameExclude.swift

@@ -5,6 +5,7 @@ class SentrySwizzleClassNameExclude: NSObject {
     static func shouldExcludeClass(className: String, swizzleClassNameExcludes: Set<String>) -> Bool {
         for exclude in swizzleClassNameExcludes {
             if className.contains(exclude) {
+                SentryLog.debug("Excluding class \(className) from swizzling cause it matches the exclude pattern: \(exclude).")
                 return true
             }
         }