Commit 89dc510

This is a legacy flag. Use [`dataCollection`](#dataCollection) for granular control over automatically collected data.

For backwards compatibility, `sendDefaultPii` keeps its existing behavior when no Data Collection field is configured. As soon as you configure any `dataCollection` field, Data Collection becomes the source of truth for its categories and `sendDefaultPii` no longer controls them.

<SdkOption name="dataCollection" type="DataCollection" availableSince="8.58.0">

Controls which categories of data SDK integrations collect automatically. Data Collection applies only where an integration supports the category. It doesn't remove data you add explicitly through scopes, event processors, or callbacks such as `beforeSend`.

<Alert>

Call `options.getDataCollection().forceDataCollection()` or explicitly configure any field to enable Data Collection. All fields you don't configure use the defaults below, and the `sendDefaultPii` option is ignored.

</Alert>

| Field | Type | Default | Behavior |

| ------------------------ | ---------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |

| `userInfo` | `boolean` | `true` | Allows integrations to populate user identity and IP address information. |

| `cookies`\* | `KeyValueCollectionBehavior` | `DENY_LIST` | Collects cookies and filters sensitive values. |

| `httpHeaders.request`\* | `KeyValueCollectionBehavior` | `DENY_LIST` | Collects request headers and filters sensitive values. |

| `httpHeaders.response`\* | `KeyValueCollectionBehavior` | `DENY_LIST` | Collects response headers and filters sensitive values. |

| `httpBodies` | `Set<HttpBodyType>` | all body types | Collects supported incoming and outgoing request and response bodies. An empty set disables body collection. |

| `urlQueryParams`\* | `KeyValueCollectionBehavior` | `DENY_LIST` | Collects URL query parameters and filters sensitive values. |

| `graphql.document` | `boolean` | `true` | Collects GraphQL documents. |

| `graphql.variables` | `boolean` | `true` | Collects GraphQL variables. |

| `filePaths` | `boolean` | `true` | Allows File I/O instrumentation to collect file names and absolute paths. File extensions and byte counts remain available when disabled. |

\* Fields marked with an asterisk take a single `KeyValueCollectionBehavior` value in code. Properties, environment variables, Spring Boot, and Android manifest metadata expose that value as separate `mode` and `terms` settings. `terms` contains additional matching terms for deny-list or allow-list behavior.

The marked fields support three modes:

- `OFF` (`KeyValueCollectionBehavior.off()`): Don't collect the category.

- `DENY_LIST` (`KeyValueCollectionBehavior.denyList(...)`): Collect values except those matching the built-in sensitive list or additional configured terms. The no-argument constructor uses this mode without custom terms.

- `ALLOW_LIST` (`KeyValueCollectionBehavior.allowList(...)`): Include plaintext values only for keys that match configured terms and don't match the built-in sensitive list. Sensitive values are always replaced with `"[Filtered]"`.

Matching is partial and case-insensitive. The built-in terms are `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 the built-in list rather than replacing it.

When migrating from `sendDefaultPii=false`, configuring Data Collection causes supported integrations to send HTTP request and response headers by default. Review these headers for sensitive data and adjust `httpHeaders.request` and `httpHeaders.response` as needed.

The legacy header filtering also omitted sensitive headers such as `X-Forwarded-For`, `X-Real-IP`, and `Remote-Addr` in supported integrations. After you configure any Data Collection field, `sendDefaultPii` no longer controls these headers. Data Collection's default deny list filters credential and secret values but doesn't automatically match those identifying headers. To continue filtering them, add `forwarded`, `-ip`, `remote-`, `via`, and `-user` to a deny list. These terms also match keys such as `CF-Connecting-IP` and `X-User-Id`. Add them to `cookies`, `httpHeaders.request`, `httpHeaders.response`, or `urlQueryParams` as needed.

Configure Data Collection in `AndroidManifest.xml`:

```xml {filename:AndroidManifest.xml}

<application>

<meta-data

android:name="io.sentry.data-collection.user-info"

android:value="false" />

<meta-data

android:name="io.sentry.data-collection.http-bodies"

android:value="outgoing_request,incoming_response" />

<meta-data

android:name="io.sentry.data-collection.http-headers.request.mode"

android:value="deny_list" />

<meta-data

android:name="io.sentry.data-collection.http-headers.request.terms"

android:value="forwarded,-ip,remote-,via,-user" />

<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" />

</application>

Supported manifest keys are:

- `io.sentry.data-collection.user-info`

- `io.sentry.data-collection.http-bodies`

- `io.sentry.data-collection.cookies.mode` and `.terms`

- `io.sentry.data-collection.http-headers.request.mode` and `.terms`

- `io.sentry.data-collection.http-headers.response.mode` and `.terms`

- `io.sentry.data-collection.url-query-params.mode` and `.terms`

- `io.sentry.data-collection.graphql.document`

- `io.sentry.data-collection.graphql.variables`

- `io.sentry.data-collection.file-paths`

For manual initialization, use the same Java API as the Java SDK:

import io.sentry.KeyValueCollectionBehavior

import io.sentry.android.core.SentryAndroid

SentryAndroid.init(this) { options ->

options.dataCollection.userInfo = false

options.dataCollection.filePaths = false

options.dataCollection.urlQueryParams = KeyValueCollectionBehavior.off()

options.dataCollection.httpHeaders.request =

KeyValueCollectionBehavior.denyList("forwarded", "-ip", "remote-", "via", "-user")

}

Data Collection preserves existing applications until you opt in:

| Configuration | Result |

| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |

| No Data Collection fields | Existing `sendDefaultPii` behavior is preserved. |

| `forceDataCollection()` | All Data Collection categories use the defaults above. |

| Any Data Collection field | That field uses its configured value, omitted fields use the defaults above, and `sendDefaultPii` is ignored for Data Collection categories. |

If you previously used `sendDefaultPii=false`, either leave Data Collection unset to preserve that behavior or explicitly disable every category you don't want collected. If you used `sendDefaultPii=true`, call `options.getDataCollection().forceDataCollection()` to opt into the new filtered defaults.

Data Collection doesn't control Session Replay. Configure Replay's URL, header, and body collection separately in the <PlatformLink to="/session-replay/configuration/">Session Replay options</PlatformLink>.

</SdkOption>