Skip to content

fix(js/browser): Amend user IP + sendDefaultPii change to v10 migration guide #14609

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+23 −0
Open

fix(js/browser): Amend user IP + sendDefaultPii change to v10 migration guide #14609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions docs/platforms/javascript/common/migration/v9-to-v10.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,29 @@ The removal entails **no breaking API changes**. However, in rare cases, you mig

The `_experiments.autoFlushOnFeedback` option was removed and is now the default behavior.

## Update: User IP Address collection gated by `sendDefaultPii`

Version `10.4.0` introduced a change that should have ideally been introduced with `10.0.0` of the SDK.
Originally destined for [version `9.0.0`](https://docs.sentry.io/platforms/javascript/migration/v8-to-v9/#behavior-changes), but having not the desired effect until v10,
SDKs will now control IP address inference of user IP addresses depending on the value of the top level `sendDefaultPii` init option.

- If `sendDefaultPii` is `true`, Sentry will infer the IP address of users' devices to events (errors, traces, replays, etc) in all browser-based SDKs.
- If `sendDefaultPii` is `false` or not set, Sentry will not infer or collect IP address data.

Given that this was already [advertised behaviour](https://docs.sentry.io/platforms/javascript/data-management/data-collected/#users-ip-address-and-location) since v9,
we classify the change [as a fix](https://github.com/getsentry/sentry-javascript/pull/17364), though we recognize the potential impact of it.

If you want to continue receiving user IP addresses, set `sendDefaultPii: true` in your `Sentry.init` config:

```js
Sentry.init({
// ...
sendDefaultPii: true,
});
```

We apologize for any inconvenience caused.

</PlatformCategorySection>

## Removed APIs
Expand Down