Explicity set user.ip_address: {{auto}}

[cleptric]

Description

For client side SDKs, we need to explicitly set the user's IP address to {{auto}}, if the property was not set by the user.

By default, SDKs should not set {{auto}} and only do so if sendDefaultPii was set to true by the user.

Docs: https://develop.sentry.dev/sdk/expected-features/data-handling/

See getsentry/relay#4431

Stakeholder(s)

@jjbayer

Team(s)

Mobile, Web Frontend, GDX

SDKs

SDKs

Preview Give feedback

1. Flutter SDK - Does already set {{auto}} https://github.com/getsentry/sentry-dart/blob/d1488a1bce9359342af5062f910a087dc2250e6e/dart/lib/src/sentry_client.dart#L35-L38
2. Dart SDK - Depends on Flutter SDK
3. Apple/Cocoa SDK https://github.com/getsentry/sentry-cocoa/blob/72e34fae44b817d8c12490bbc5c1ce7540f86762/Sources/Sentry/SentryClient.m#L781-L786
4. Explicity set user.ip_address: {{auto}} sentry-java#4068
   Platform: Android Platform: Java +2
   
5. Kotlin Multiplatform SDK - depends on Apple/Cocoa and Java/Android SDK
6. Electron SDK - feat: Explicitly set user.ip_address: {{auto}} sentry-electron#1057
7. JavaScript SDK - feat(browser): Set user.ip_address explicitly to {{auto}} sentry-javascript#15008 & Implement sendDefaultPii behaviour in the JS SDKs sentry-javascript#5347
8. .NET SDK - fix: Guard user.IpAddress = "{{ auto }}" by SendDefaultPii sentry-dotnet#3893
9. Unity SDK - Inherits it from the .NET SDK, see above.
10. PowerShell SDK - Inherits it from the .NET SDK, see above.
11. Unreal SDK
12. Capacitor SDK Explicity set user.ip_address: {{auto}} sentry-capacitor#819
13. Cordova SDK Explicity set user.ip_address: {{auto}} sentry-cordova#369
14. Explicity set user.ip_address: {{auto}} sentry-react-native#4462
    Platform: React-Native +1
    

[bruno-garcia]

@bitsandfoxes I'm pretty sure Unity does the right thing (the dotnet sdk that is, which would be true then for Unity, Xamarin and PowerShell. But could you please double check?

[kahest]

sentry-cocoa already sets {{auto}} in https://github.com/getsentry/sentry-cocoa/blob/72e34fae44b817d8c12490bbc5c1ce7540f86762/Sources/Sentry/SentryClient.m#L781-L786, marking as done

[jjbayer]

for spans, relay populates the client.address attribute (even if no explicit auto is set):
https://github.com/getsentry/relay/blob/2e5e53191f4cf960b49bed86ab6564552084a0b1/relay-server/src/services/processor/span/processing.rs#L582-L590

for sessions there's the ip_address attribute:
https://github.com/getsentry/relay/blob/2e5e53191f4cf960b49bed86ab6564552084a0b1/relay-event-schema/src/protocol/session.rs#L484-L496

[lucas-zimerman]

Issue created for Capacitor getsentry/sentry-capacitor#819
and Cordova getsentry/sentry-cordova#369

[jjbayer]

Current Relay behavior:

Data type	auto-derive when IP missing	auto-derive when IP is {{auto}}
Errors + Transactions	only for platform:[js,cocoa]	Yes
Sessions	No	Yes
Standalone (INP) spans	Yes	Yes
Replays	only for platform:[js,cocoa]	Yes

We can change the special casing for js and cocoa to a specific verion. Since INP spans also come from javascript, we can apply the same fallback behavior there, so the behavior is aligned across data types.

[krystofwoldrich]

@jjbayer What is covered by js, any sdk starting with sentry.javascript.*? Just checking what the behaviour will be for hybrid SDKs (RN, Flutter, ...).