Allow opting out of device info collection that requires Inter-Process Communication (IPC) (#2100)

* Allow opting out of device info requiring IPC

* Add changelog

* Update sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java

Co-authored-by: Manoel Aranda Neto <[email protected]>

* Remove logger

* Rename option and manifest entry

* Allow opting out of getDeviceIo completely

Co-authored-by: Manoel Aranda Neto <[email protected]>

Author: adinauer

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 - Replace `tracestate` header with `baggage` header ([#2078](https://github.com/getsentry/sentry-java/pull/2078))
+- Allow opting out of device info collection that requires Inter-Process Communication (IPC) ([#2100](https://github.com/getsentry/sentry-java/pull/2100))
 
 ## 6.1.0
 

sentry-android-core/api/sentry-android-core.api

@@ -129,6 +129,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun isAnrEnabled ()Z
 	public fun isAnrReportInDebug ()Z
 	public fun isAttachScreenshot ()Z
+	public fun isCollectAdditionalContext ()Z
 	public fun isEnableActivityLifecycleBreadcrumbs ()Z
 	public fun isEnableActivityLifecycleTracingAutoFinish ()Z
 	public fun isEnableAppComponentBreadcrumbs ()Z
@@ -141,6 +142,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun setAnrReportInDebug (Z)V
 	public fun setAnrTimeoutIntervalMillis (J)V
 	public fun setAttachScreenshot (Z)V
+	public fun setCollectAdditionalContext (Z)V
 	public fun setDebugImagesLoader (Lio/sentry/android/core/IDebugImagesLoader;)V
 	public fun setEnableActivityLifecycleBreadcrumbs (Z)V
 	public fun setEnableActivityLifecycleTracingAutoFinish (Z)V

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

@@ -146,7 +146,8 @@ static void init(
 
     readDefaultOptionValues(options, context);
 
-    options.addEventProcessor(new DefaultAndroidEventProcessor(context, logger, buildInfoProvider));
+    options.addEventProcessor(
+        new DefaultAndroidEventProcessor(context, buildInfoProvider, options));
     options.addEventProcessor(new PerformanceAndroidEventProcessor(options, activityFramesTracker));
 
     options.setTransportGate(new AndroidTransportGate(context, options.getLogger()));

sentry-android-core/src/main/java/io/sentry/android/core/DefaultAndroidEventProcessor.java

@@ -23,7 +23,6 @@
 import io.sentry.DateUtils;
 import io.sentry.EventProcessor;
 import io.sentry.Hint;
-import io.sentry.ILogger;
 import io.sentry.SentryBaseEvent;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
@@ -69,26 +68,29 @@ final class DefaultAndroidEventProcessor implements EventProcessor {
 
   private final @NotNull BuildInfoProvider buildInfoProvider;
   private final @NotNull RootChecker rootChecker;
-
-  private final @NotNull ILogger logger;
+  private final @NotNull SentryAndroidOptions options;
 
   public DefaultAndroidEventProcessor(
       final @NotNull Context context,
-      final @NotNull ILogger logger,
-      final @NotNull BuildInfoProvider buildInfoProvider) {
-    this(context, logger, buildInfoProvider, new RootChecker(context, buildInfoProvider, logger));
+      final @NotNull BuildInfoProvider buildInfoProvider,
+      final @NotNull SentryAndroidOptions options) {
+    this(
+        context,
+        buildInfoProvider,
+        new RootChecker(context, buildInfoProvider, options.getLogger()),
+        options);
   }
 
   DefaultAndroidEventProcessor(
       final @NotNull Context context,
-      final @NotNull ILogger logger,
       final @NotNull BuildInfoProvider buildInfoProvider,
-      final @NotNull RootChecker rootChecker) {
+      final @NotNull RootChecker rootChecker,
+      final @NotNull SentryAndroidOptions options) {
     this.context = Objects.requireNonNull(context, "The application context is required.");
-    this.logger = Objects.requireNonNull(logger, "The Logger is required.");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "The BuildInfoProvider is required.");
     this.rootChecker = Objects.requireNonNull(rootChecker, "The RootChecker is required.");
+    this.options = Objects.requireNonNull(options, "The options object is required.");
 
     ExecutorService executorService = Executors.newSingleThreadExecutor();
     // dont ref. to method reference, theres a bug on it
@@ -149,10 +151,12 @@ private boolean shouldApplyScopeData(
     if (HintUtils.shouldApplyScopeData(hint)) {
       return true;
     } else {
-      logger.log(
-          SentryLevel.DEBUG,
-          "Event was cached so not applying data relevant to the current app execution/version: %s",
-          event.getEventId());
+      options
+          .getLogger()
+          .log(
+              SentryLevel.DEBUG,
+              "Event was cached so not applying data relevant to the current app execution/version: %s",
+              event.getEventId());
       return false;
     }
   }
@@ -220,7 +224,7 @@ private void setThreads(final @NotNull SentryEvent event) {
 
   private void setPackageInfo(final @NotNull SentryBaseEvent event, final @NotNull App app) {
     final PackageInfo packageInfo =
-        ContextUtils.getPackageInfo(context, PackageManager.GET_PERMISSIONS, logger);
+        ContextUtils.getPackageInfo(context, PackageManager.GET_PERMISSIONS, options.getLogger());
     if (packageInfo != null) {
       String versionCode = ContextUtils.getVersionCode(packageInfo);
 
@@ -287,7 +291,9 @@ private void setArchitectures(final @NotNull Device device) {
 
     // setting such values require IO hence we don't run for transactions
     if (errorEvent) {
-      setDeviceIO(device, applyScopeData);
+      if (options.isCollectAdditionalContext()) {
+        setDeviceIO(device, applyScopeData);
+      }
     }
 
     device.setOrientation(getOrientation());
@@ -298,7 +304,7 @@ private void setArchitectures(final @NotNull Device device) {
         device.setSimulator((Boolean) emulator);
       }
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting emulator.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting emulator.", e);
     }
 
     DisplayMetrics displayMetrics = getDisplayMetrics();
@@ -336,7 +342,7 @@ private void setDeviceIO(final @NotNull Device device, final boolean applyScopeD
     }
 
     Boolean connected;
-    switch (ConnectivityChecker.getConnectionStatus(context, logger)) {
+    switch (ConnectivityChecker.getConnectionStatus(context, options.getLogger())) {
       case NOT_CONNECTED:
         connected = false;
         break;
@@ -361,7 +367,8 @@ private void setDeviceIO(final @NotNull Device device, final boolean applyScopeD
     }
 
     // this way of getting the size of storage might be problematic for storages bigger than 2GB
-    // check the use of https://developer.android.com/reference/java/io/File.html#getFreeSpace%28%29
+    // check the use of
+    // https://developer.android.com/reference/java/io/File.html#getFreeSpace%28%29
     final File internalStorageFile = context.getExternalFilesDir(null);
     if (internalStorageFile != null) {
       StatFs internalStorageStat = new StatFs(internalStorageFile.getPath());
@@ -378,7 +385,7 @@ private void setDeviceIO(final @NotNull Device device, final boolean applyScopeD
     if (device.getConnectionType() == null) {
       // wifi, ethernet or cellular, null if none
       device.setConnectionType(
-          ConnectivityChecker.getConnectionType(context, logger, buildInfoProvider));
+          ConnectivityChecker.getConnectionType(context, options.getLogger(), buildInfoProvider));
     }
   }
 
@@ -409,7 +416,7 @@ private TimeZone getTimeZone() {
       // currentTimeMillis returns UTC already
       return DateUtils.getDateTime(System.currentTimeMillis() - SystemClock.elapsedRealtime());
     } catch (IllegalArgumentException e) {
-      logger.log(SentryLevel.ERROR, e, "Error getting the device's boot time.");
+      options.getLogger().log(SentryLevel.ERROR, e, "Error getting the device's boot time.");
     }
     return null;
   }
@@ -427,10 +434,10 @@ private TimeZone getTimeZone() {
         actManager.getMemoryInfo(memInfo);
         return memInfo;
       }
-      logger.log(SentryLevel.INFO, "Error getting MemoryInfo.");
+      options.getLogger().log(SentryLevel.INFO, "Error getting MemoryInfo.");
       return null;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting MemoryInfo.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting MemoryInfo.", e);
       return null;
     }
   }
@@ -449,7 +456,7 @@ private TimeZone getTimeZone() {
     try {
       return Build.MODEL.split(" ", -1)[0];
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting device family.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting device family.", e);
       return null;
     }
   }
@@ -472,7 +479,7 @@ private TimeZone getTimeZone() {
 
       return ((float) level / (float) scale) * percentMultiplier;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting device battery level.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting device battery level.", e);
       return null;
     }
   }
@@ -488,7 +495,7 @@ private TimeZone getTimeZone() {
       return plugged == BatteryManager.BATTERY_PLUGGED_AC
           || plugged == BatteryManager.BATTERY_PLUGGED_USB;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting device charging state.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting device charging state.", e);
       return null;
     }
   }
@@ -500,7 +507,7 @@ private TimeZone getTimeZone() {
         return ((float) temperature) / 10; // celsius
       }
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting battery temperature.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting battery temperature.", e);
     }
     return null;
   }
@@ -517,13 +524,15 @@ private TimeZone getTimeZone() {
       deviceOrientation =
           DeviceOrientations.getOrientation(context.getResources().getConfiguration().orientation);
       if (deviceOrientation == null) {
-        logger.log(
-            SentryLevel.INFO,
-            "No device orientation available (ORIENTATION_SQUARE|ORIENTATION_UNDEFINED)");
+        options
+            .getLogger()
+            .log(
+                SentryLevel.INFO,
+                "No device orientation available (ORIENTATION_SQUARE|ORIENTATION_UNDEFINED)");
         return null;
       }
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting device orientation.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting device orientation.", e);
     }
     return deviceOrientation;
   }
@@ -539,7 +548,7 @@ private TimeZone getTimeZone() {
       long totalBlocks = getBlockCountLong(stat);
       return totalBlocks * blockSize;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting total internal storage amount.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting total internal storage amount.", e);
       return null;
     }
   }
@@ -594,7 +603,9 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
       long availableBlocks = getAvailableBlocksLong(stat);
       return availableBlocks * blockSize;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting unused internal storage amount.", e);
+      options
+          .getLogger()
+          .log(SentryLevel.ERROR, "Error getting unused internal storage amount.", e);
       return null;
     }
   }
@@ -605,10 +616,10 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
       if (path != null) { // && path.canRead()) { canRead() will read return false
         return new StatFs(path.getPath());
       }
-      logger.log(SentryLevel.INFO, "Not possible to read external files directory");
+      options.getLogger().log(SentryLevel.INFO, "Not possible to read external files directory");
       return null;
     }
-    logger.log(SentryLevel.INFO, "External storage is not mounted or emulated.");
+    options.getLogger().log(SentryLevel.INFO, "External storage is not mounted or emulated.");
     return null;
   }
 
@@ -649,7 +660,7 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
         return file;
       }
     } else {
-      logger.log(SentryLevel.INFO, "Not possible to read getExternalFilesDirs");
+      options.getLogger().log(SentryLevel.INFO, "Not possible to read getExternalFilesDirs");
     }
     return null;
   }
@@ -666,7 +677,7 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
       long totalBlocks = getBlockCountLong(stat);
       return totalBlocks * blockSize;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting total external storage amount.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting total external storage amount.", e);
       return null;
     }
   }
@@ -690,7 +701,9 @@ private boolean isExternalStorageMounted() {
       long availableBlocks = getAvailableBlocksLong(stat);
       return availableBlocks * blockSize;
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting unused external storage amount.", e);
+      options
+          .getLogger()
+          .log(SentryLevel.ERROR, "Error getting unused external storage amount.", e);
       return null;
     }
   }
@@ -704,7 +717,7 @@ private boolean isExternalStorageMounted() {
     try {
       return context.getResources().getDisplayMetrics();
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting DisplayMetrics.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting DisplayMetrics.", e);
       return null;
     }
   }
@@ -726,7 +739,7 @@ private boolean isExternalStorageMounted() {
         os.setRooted((Boolean) rooted);
       }
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting OperatingSystem.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting OperatingSystem.", e);
     }
 
     return os;
@@ -781,7 +794,7 @@ private void setAppPackageInfo(final @NotNull App app, final @NotNull PackageInf
     try (BufferedReader br = new BufferedReader(new FileReader(file))) {
       return br.readLine();
     } catch (IOException e) {
-      logger.log(SentryLevel.ERROR, errorMsg, e);
+      options.getLogger().log(SentryLevel.ERROR, errorMsg, e);
     }
 
     return defaultVersion;
@@ -805,7 +818,7 @@ private void setAppPackageInfo(final @NotNull App app, final @NotNull PackageInf
         return context.getString(stringId);
       }
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting application name.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting application name.", e);
     }
 
     return null;
@@ -827,7 +840,7 @@ private void setAppPackageInfo(final @NotNull App app, final @NotNull PackageInf
     try {
       return Installation.id(context);
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting installationId.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting installationId.", e);
     }
     return null;
   }
@@ -836,7 +849,7 @@ private void setAppPackageInfo(final @NotNull App app, final @NotNull PackageInf
   private @Nullable Map<String, String> getSideLoadedInfo() {
     String packageName = null;
     try {
-      final PackageInfo packageInfo = ContextUtils.getPackageInfo(context, logger);
+      final PackageInfo packageInfo = ContextUtils.getPackageInfo(context, options.getLogger());
       final PackageManager packageManager = context.getPackageManager();
 
       if (packageInfo != null && packageManager != null) {
@@ -861,7 +874,7 @@ private void setAppPackageInfo(final @NotNull App app, final @NotNull PackageInf
       }
     } catch (IllegalArgumentException e) {
       // it'll never be thrown as we are querying its own App's package.
-      logger.log(SentryLevel.DEBUG, "%s package isn't installed.", packageName);
+      options.getLogger().log(SentryLevel.DEBUG, "%s package isn't installed.", packageName);
     }
 
     return null;
@@ -879,7 +892,7 @@ private void setSideLoadedInfo(final @NotNull SentryBaseEvent event) {
         }
       }
     } catch (Throwable e) {
-      logger.log(SentryLevel.ERROR, "Error getting side loaded info.", e);
+      options.getLogger().log(SentryLevel.ERROR, "Error getting side loaded info.", e);
     }
   }
 

sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java

@@ -71,6 +71,7 @@ final class ManifestMetadataReader {
 
   static final String ATTACH_SCREENSHOT = "io.sentry.attach-screenshot";
   static final String CLIENT_REPORTS_ENABLE = "io.sentry.send-client-reports";
+  static final String COLLECT_ADDITIONAL_CONTEXT = "io.sentry.additional-context";
 
   /** ManifestMetadataReader ctor */
   private ManifestMetadataReader() {}
@@ -210,6 +211,13 @@ static void applyMetadata(
         options.setSendClientReports(
             readBool(metadata, logger, CLIENT_REPORTS_ENABLE, options.isSendClientReports()));
 
+        options.setCollectAdditionalContext(
+            readBool(
+                metadata,
+                logger,
+                COLLECT_ADDITIONAL_CONTEXT,
+                options.isCollectAdditionalContext()));
+
         if (options.getTracesSampleRate() == null) {
           final Double tracesSampleRate = readDouble(metadata, logger, TRACES_SAMPLE_RATE);
           if (tracesSampleRate != -1) {