Skip to content

docs(java): Warn about sendDefaultPii removal #19598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adinauer merged 2 commits into from
Sep 25, 2026
Merged

docs(java): Warn about sendDefaultPii removal #19598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a287d7d
docs(java): Warn about sendDefaultPii removal
adinauer Sep 24, 2026
e19aba9
Merge branch 'master' into docs/java-android-send-default-pii-depreca…
adinauer Sep 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/platforms/android/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,12 @@ AndroidManifest.xml key: `io.sentry.additional-context`.

<SdkOption name="sendDefaultPii" type="bool" defaultValue="false">

If this flag is enabled, certain personally identifiable information (PII) is added by active integrations.
<Alert level="warning">
`sendDefaultPii` is deprecated and will be removed in the next major version
(v9). Use [`dataCollection`](#dataCollection) instead.
</Alert>

This is a legacy flag. Use [`dataCollection`](#dataCollection) for granular control over automatically collected data.
If this flag is enabled, certain personally identifiable information (PII) is added by active integrations.

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.

Expand Down
7 changes: 5 additions & 2 deletions docs/platforms/java/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,17 @@ Note that enabling this option may increase the payload size of events sent to S

<SdkOption name="sendDefaultPii" type="boolean" defaultValue="false">

<Alert level="warning">
`sendDefaultPii` is deprecated and will be removed in the next major version
(v9). Use [`dataCollection`](#dataCollection) instead.
</Alert>

If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.

This option is turned off by default.

If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/).

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.

Unencoded Logback messages aren't a Data Collection category. To include original message templates and parameters when an encoder is configured, use the Logback appender's `includeUnencodedMessage` option. The legacy `sendDefaultPii` behavior remains supported for compatibility. OpenTelemetry-derived HTTP data also isn't controlled by Data Collection yet. Sensitive HTTP header attributes continue to use `sendDefaultPii`; URL and query string attributes are collected when present regardless of that flag.
Expand Down
Loading