Skip to content

Commit 1788436

Browse files
committed
changelog and migration guide entries
1 parent 3809e58 commit 1788436

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@
44

55
- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
66

7+
## Unreleased
8+
9+
### Important Changes
10+
11+
- **fix(browser): Ensure IP address is only inferred by Relay if `sendDefaultPii` is `true`**
12+
13+
This release includes a fix for a [behaviour change](https://docs.sentry.io/platforms/javascript/migration/v8-to-v9/#behavior-changes)
14+
that was originally introduced with v9 of the SDK: User IP Addresses should only be added to Sentry events automatically,
15+
if `sendDefaultPii` was set to `true`.
16+
17+
However, the change in v9 required further internal adjustment, which should have been included in v10 of the SDK.
18+
Unfortunately, the change did not make it into the initial v10 version but is now applied with `10.4.0`.
19+
There is _no API_ breakage involved and hence it is safe to update.
20+
However, after updating the SDK, events (errors, traces, replays, etc.) sent from the browser, will only include
21+
user IP addresses, if you set `sendDefaultPii: true` in your `Sentry.init` options.
22+
23+
We apologize for any inconvenience caused!
24+
725
## 10.3.0
826

927
- feat(core): MCP Server - Capture prompt results from prompt function calls (#17284)

MIGRATION.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,18 @@ The removal entails **no breaking API changes**. However, in rare cases, you mig
8080
- If you set up Sentry Alerts that depend on FID, be aware that these could trigger once you upgrade the SDK, due to a lack of new values.
8181
To replace them, adjust your alerts (or dashbaords) to use INP.
8282

83+
### Update: User IP Address collection gated by `sendDefaultPii`
84+
85+
Version `10.4.0` introduced a change that should have ideally been introduced with `10.0.0` of the SDK.
86+
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,
87+
SDKs will now control IP address inference of user IP addresses depending on the value of the top level `sendDefaultPii` init option.
88+
89+
- If `sendDefaultPii` is `true`, Sentry will infer the IP address of users' devices to events (errors, traces, replays, etc) in all browser-based SDKs.
90+
- If `sendDefaultPii` is `false` or not set, Sentry will not infer or collect IP address data.
91+
92+
Given that this was already the advertised behaviour since v9, we classify the change [as a fix](https://github.com/getsentry/sentry-javascript/pull/17364),
93+
though we recognize the potential impact of it. We apologize for any inconvenience caused.
94+
8395
## No Version Support Timeline
8496

8597
Version support timelines are stressful for everybody using the SDK, so we won't be defining one.

0 commit comments

Comments
 (0)