feat(core): [Data Collection 25] Apply file path policy

Add the specification-defined filePaths option across programmatic, external, Spring Boot, and Android manifest configuration. Gate automatically captured File I/O paths through the resolved policy while preserving sendDefaultPii when Data Collection is absent.\n\nRefs #5666

Author: adinauer

CHANGELOG.md

@@ -20,6 +20,7 @@
   | `graphql.document` | `true` | Collects GraphQL documents. |
   | `graphql.variables` | `true` | Collects GraphQL variables. |
   | `databaseQueryData` | `true` | Allows collection of associated query data, such as bound parameters, write payloads, and results, where supported. Sanitized query statements and structural database metadata remain available. |
+  | `filePaths` | `true` | Allows file-system instrumentation to collect file and directory paths. File extensions and byte counts remain available when disabled. |
 
   Cookies, HTTP headers, and URL query parameters support three modes:
 
@@ -29,7 +30,7 @@
 
   Matching is case-insensitive and partial. The built-in sensitive deny-list contains `auth`, `token`, `secret`, `password`, `passwd`, `pwd`, `key`, `jwt`, `bearer`, `sso`, `saml`, `csrf`, `xsrf`, `credentials`, `session`, `sid`, and `identity`. Filtered values are replaced with `"[Filtered]"`. Custom deny-list terms extend rather than replace this list.
 
-  Configure all HTTP body types, a custom cookie deny-list, a request-header allow-list, and disable URL query parameter collection in an options callback:
+  Configure all HTTP body types, a custom cookie deny-list, a request-header allow-list, and disable URL query parameter and file path collection in an options callback:
 
   ```java
   Sentry.init(
@@ -55,6 +56,7 @@
         options
             .getDataCollection()
             .setUrlQueryParams(KeyValueCollectionBehavior.off());
+        options.getDataCollection().setFilePaths(false);
       });
   ```
 
@@ -67,6 +69,7 @@
   data-collection.http-headers.request.mode=allow_list
   data-collection.http-headers.request.terms=content-type,x-request-id
   data-collection.url-query-params.mode=off
+  data-collection.file-paths=false
   ```
 
   Configure them with Spring Boot properties:
@@ -78,6 +81,7 @@
   sentry.data-collection.http-headers.request.mode=allow-list
   sentry.data-collection.http-headers.request.terms=content-type,x-request-id
   sentry.data-collection.url-query-params.mode=off
+  sentry.data-collection.file-paths=false
   ```
 
   Configure them in `AndroidManifest.xml`:
@@ -101,6 +105,9 @@
   <meta-data
       android:name="io.sentry.data-collection.url-query-params.mode"
       android:value="off" />
+  <meta-data
+      android:name="io.sentry.data-collection.file-paths"
+      android:value="false" />
   ```
 
   See the [Data Collection documentation](https://docs.sentry.io/platforms/java/configuration/options/#dataCollection) for all configuration keys, supported integrations, and migration guidance.

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

@@ -126,6 +126,7 @@ final class ManifestMetadataReader {
       "io.sentry.data-collection.graphql.variables";
   static final String DATA_COLLECTION_DATABASE_QUERY_DATA =
       "io.sentry.data-collection.database-query-data";
+  static final String DATA_COLLECTION_FILE_PATHS = "io.sentry.data-collection.file-paths";
 
   static final String PERFORM_FRAMES_TRACKING = "io.sentry.traces.frames-tracking";
 
@@ -886,6 +887,10 @@ static void applyMetadata(
           readBool(metadata, logger, DATA_COLLECTION_DATABASE_QUERY_DATA, false));
     }
 
+    if (containsKey(metadata, DATA_COLLECTION_FILE_PATHS)) {
+      dataCollection.setFilePaths(readBool(metadata, logger, DATA_COLLECTION_FILE_PATHS, false));
+    }
+
     return dataCollection.isExplicitlyConfigured() ? dataCollection : null;
   }
 
@@ -918,6 +923,9 @@ private static void mergeDataCollection(
     if (source.getDatabaseQueryData() != null) {
       target.setDatabaseQueryData(source.getDatabaseQueryData());
     }
+    if (source.getFilePaths() != null) {
+      target.setFilePaths(source.getFilePaths());
+    }
   }
 
   private static @NotNull Set<HttpBodyType> readHttpBodyTypes(

sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt

@@ -1485,6 +1485,7 @@ class ManifestMetadataReaderTest {
         ManifestMetadataReader.DATA_COLLECTION_GRAPHQL_DOCUMENT to false,
         ManifestMetadataReader.DATA_COLLECTION_GRAPHQL_VARIABLES to true,
         ManifestMetadataReader.DATA_COLLECTION_DATABASE_QUERY_DATA to false,
+        ManifestMetadataReader.DATA_COLLECTION_FILE_PATHS to false,
       )
     val context = fixture.getContext(metaData = bundle)
 
@@ -1504,6 +1505,7 @@ class ManifestMetadataReaderTest {
     assertThat(dataCollection.graphql.document).isFalse()
     assertThat(dataCollection.graphql.variables).isTrue()
     assertThat(dataCollection.databaseQueryData).isFalse()
+    assertThat(dataCollection.filePaths).isFalse()
   }
 
   @Test
@@ -1519,6 +1521,7 @@ class ManifestMetadataReaderTest {
         graphql.setDocument(true)
         graphql.setVariables(false)
         setDatabaseQueryData(true)
+        setFilePaths(true)
       }
     val bundle =
       bundleOf(
@@ -1543,6 +1546,7 @@ class ManifestMetadataReaderTest {
     assertThat(dataCollection.graphql.document).isTrue()
     assertThat(dataCollection.graphql.variables).isFalse()
     assertThat(dataCollection.databaseQueryData).isTrue()
+    assertThat(dataCollection.filePaths).isTrue()
   }
 
   @Test

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt

@@ -308,7 +308,7 @@ class SentryAutoConfigurationTest {
   }
 
   @Test
-  fun `data collection key value properties are applied to SentryOptions`() {
+  fun `data collection properties are applied to SentryOptions`() {
     contextRunner
       .withPropertyValues(
         "sentry.dsn=http://key@localhost/proj",
@@ -319,6 +319,7 @@ class SentryAutoConfigurationTest {
         "sentry.data-collection.http-headers.request.terms=forwarded,-ip",
         "sentry.data-collection.http-headers.response.mode=allow-list",
         "sentry.data-collection.http-headers.response.terms=content-type,x-request-id",
+        "sentry.data-collection.file-paths=false",
       )
       .run {
         val dataCollection = it.getBean(SentryProperties::class.java).dataCollection
@@ -333,6 +334,7 @@ class SentryAutoConfigurationTest {
           .isEqualTo(KeyValueCollectionBehavior.Mode.ALLOW_LIST)
         assertThat(dataCollection.httpHeaders.response!!.terms)
           .containsExactly("content-type", "x-request-id")
+        assertThat(dataCollection.filePaths).isFalse()
       }
   }
 

sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt

@@ -316,7 +316,7 @@ class SentryAutoConfigurationTest {
   }
 
   @Test
-  fun `data collection key value properties are applied to SentryOptions`() {
+  fun `data collection properties are applied to SentryOptions`() {
     contextRunner
       .withPropertyValues(
         "sentry.dsn=http://key@localhost/proj",
@@ -327,6 +327,7 @@ class SentryAutoConfigurationTest {
         "sentry.data-collection.http-headers.request.terms=forwarded,-ip",
         "sentry.data-collection.http-headers.response.mode=allow-list",
         "sentry.data-collection.http-headers.response.terms=content-type,x-request-id",
+        "sentry.data-collection.file-paths=false",
       )
       .run {
         val dataCollection = it.getBean(SentryProperties::class.java).dataCollection
@@ -341,6 +342,7 @@ class SentryAutoConfigurationTest {
           .isEqualTo(KeyValueCollectionBehavior.Mode.ALLOW_LIST)
         assertThat(dataCollection.httpHeaders.response!!.terms)
           .containsExactly("content-type", "x-request-id")
+        assertThat(dataCollection.filePaths).isFalse()
       }
   }
 

sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt

@@ -314,7 +314,7 @@ class SentryAutoConfigurationTest {
   }
 
   @Test
-  fun `data collection key value properties are applied to SentryOptions`() {
+  fun `data collection properties are applied to SentryOptions`() {
     contextRunner
       .withPropertyValues(
         "sentry.dsn=http://key@localhost/proj",
@@ -325,6 +325,7 @@ class SentryAutoConfigurationTest {
         "sentry.data-collection.http-headers.request.terms=forwarded,-ip",
         "sentry.data-collection.http-headers.response.mode=allow-list",
         "sentry.data-collection.http-headers.response.terms=content-type,x-request-id",
+        "sentry.data-collection.file-paths=false",
       )
       .run {
         val dataCollection = it.getBean(SentryProperties::class.java).dataCollection
@@ -339,6 +340,7 @@ class SentryAutoConfigurationTest {
           .isEqualTo(KeyValueCollectionBehavior.Mode.ALLOW_LIST)
         assertThat(dataCollection.httpHeaders.response!!.terms)
           .containsExactly("content-type", "x-request-id")
+        assertThat(dataCollection.filePaths).isFalse()
       }
   }
 

sentry/api/sentry.api

@@ -390,6 +390,7 @@ public final class io/sentry/DataCollection {
 	public fun <init> (Z)V
 	public fun getCookies ()Lio/sentry/KeyValueCollectionBehavior;
 	public fun getDatabaseQueryData ()Ljava/lang/Boolean;
+	public fun getFilePaths ()Ljava/lang/Boolean;
 	public fun getGraphql ()Lio/sentry/DataCollection$Graphql;
 	public fun getHttpBodies ()Ljava/util/Set;
 	public fun getHttpHeaders ()Lio/sentry/DataCollection$HttpHeaders;
@@ -398,6 +399,7 @@ public final class io/sentry/DataCollection {
 	public fun isExplicitlyConfigured ()Z
 	public fun setCookies (Lio/sentry/KeyValueCollectionBehavior;)V
 	public fun setDatabaseQueryData (Z)V
+	public fun setFilePaths (Z)V
 	public fun setHttpBodies (Ljava/util/Set;)V
 	public fun setUrlQueryParams (Lio/sentry/KeyValueCollectionBehavior;)V
 	public fun setUserInfo (Z)V
@@ -426,6 +428,7 @@ public final class io/sentry/DataCollectionResolver {
 	public fun getUrlQueryParams ()Lio/sentry/KeyValueCollectionBehavior;
 	public fun isDataCollectionConfigured ()Z
 	public fun isDatabaseQueryData ()Z
+	public fun isFilePaths ()Z
 	public fun isGraphqlDocument ()Z
 	public fun isGraphqlDocumentWithLegacyAlways ()Z
 	public fun isGraphqlDocumentWithLegacyBodyGate ()Z

sentry/src/main/java/io/sentry/DataCollection.java

@@ -17,6 +17,7 @@ public final class DataCollection {
   private @Nullable KeyValueCollectionBehavior urlQueryParams;
   private @Nullable Set<HttpBodyType> httpBodies;
   private @Nullable Boolean databaseQueryData;
+  private @Nullable Boolean filePaths;
   private final @NotNull HttpHeaders httpHeaders = new HttpHeaders();
   private final @NotNull Graphql graphql = new Graphql();
 
@@ -74,6 +75,14 @@ public void setDatabaseQueryData(final boolean databaseQueryData) {
     this.databaseQueryData = databaseQueryData;
   }
 
+  public @Nullable Boolean getFilePaths() {
+    return filePaths;
+  }
+
+  public void setFilePaths(final boolean filePaths) {
+    this.filePaths = filePaths;
+  }
+
   public @NotNull HttpHeaders getHttpHeaders() {
     return httpHeaders;
   }
@@ -90,6 +99,7 @@ public boolean isExplicitlyConfigured() {
         || urlQueryParams != null
         || httpBodies != null
         || databaseQueryData != null
+        || filePaths != null
         || httpHeaders.hasOverrides()
         || graphql.hasOverrides();
   }

sentry/src/main/java/io/sentry/DataCollectionResolver.java

@@ -27,6 +27,10 @@ public boolean isDatabaseQueryData() {
     return explicitOrSendDefaultPii(options.getDataCollection().getDatabaseQueryData(), true);
   }
 
+  public boolean isFilePaths() {
+    return explicitOrSendDefaultPii(options.getDataCollection().getFilePaths(), true);
+  }
+
   public boolean isGraphqlDocument() {
     return explicitOrSendDefaultPii(options.getDataCollection().getGraphql().getDocument(), true);
   }

sentry/src/main/java/io/sentry/ExternalOptions.java

@@ -305,6 +305,11 @@ public final class ExternalOptions {
       dataCollection.setDatabaseQueryData(databaseQueryData);
     }
 
+    final Boolean filePaths = propertiesProvider.getBooleanProperty("data-collection.file-paths");
+    if (filePaths != null) {
+      dataCollection.setFilePaths(filePaths);
+    }
+
     return dataCollection.isExplicitlyConfigured() ? dataCollection : null;
   }