impr: Add extra logs for UIViewControllerSwizzling (#4511)

Add more log messages for potential troubleshooting for swizzling UIViewControllers.
getsentry · Nov 6, 2024 · f31a3ef · f31a3ef
1 parent 06d3040
commit f31a3ef
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Improvements
+
+- Add extra logs for UIViewControllerSwizzling (#4511)
+
 ## 8.40.0
 
 ## Feature

diff --git a/Sources/Sentry/SentrySubClassFinder.m b/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:@", "]);
         }];
     }];
 }

diff --git a/Sources/Sentry/SentryUIViewControllerSwizzling.m b/Sources/Sentry/SentryUIViewControllerSwizzling.m
@@ -284,16 +284,23 @@ - (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(@"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);
         }
     }
 }
@@ -318,8 +325,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.

diff --git a/Sources/Swift/Integrations/Performance/SwizzleClassNameExclude.swift b/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
             }
         }