Skip to content

fix: Guard user.IpAddress = "{{ auto }}" by SendDefaultPii #3893

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
jamescrosswell merged 10 commits into from
Jan 28, 2025
Merged

fix: Guard user.IpAddress = "{{ auto }}" by SendDefaultPii #3893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f600d9a
check of pii first
bitsandfoxes Jan 15, 2025
2db1d47
renamed test
bitsandfoxes Jan 15, 2025
0b39e1f
verify
bitsandfoxes Jan 15, 2025
7c756d2
verify net9
bitsandfoxes Jan 15, 2025
7f71200
Updated CHANGELOG.md
bitsandfoxes Jan 15, 2025
22d49d2
Merge branch 'main' into fix/wrap-user-ip-auto-pii
jamescrosswell Jan 16, 2025
dbdb17c
Merge branch 'main' into fix/wrap-user-ip-auto-pii
bitsandfoxes Jan 16, 2025
a3e4726
Merge branch 'main' into pr/3893
jamescrosswell Jan 23, 2025
dc53edb
Updated verify files
jamescrosswell Jan 23, 2025
b6d6e9d
Windows verify files
jamescrosswell Jan 23, 2025
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Significant change in behavior

- The User.IpAddress is now only set to `{{auto}}` when `SendDefaultPii` is enabled. This change gives you control over IP address collection directly on the client ([#3893](https://github.com/getsentry/sentry-dotnet/pull/3893))

### Features

- .NET on iOS: Add experimental EnableAppHangTrackingV2 configuration flag to the options binding SDK ([#3877](https://github.com/getsentry/sentry-dotnet/pull/3877))
Expand Down
10 changes: 7 additions & 3 deletions src/Sentry/Internal/Enricher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,16 @@ public void Apply(IEventLike eventLike)

// User
// Report local user if opt-in PII, no user was already set to event and feature not opted-out:
if (_options is { SendDefaultPii: true, IsEnvironmentUser: true } && !eventLike.HasUser())
if (_options.SendDefaultPii)
{
eventLike.User.Username = Environment.UserName;
if (_options.IsEnvironmentUser && !eventLike.HasUser())
{
eventLike.User.Username = Environment.UserName;
}

eventLike.User.IpAddress ??= DefaultIpAddress;
}
eventLike.User.Id ??= _options.InstallationId;
eventLike.User.IpAddress ??= DefaultIpAddress;

//Apply App startup and Boot time
eventLike.Contexts.App.StartTime ??= ProcessInfo.Instance?.StartupTime;
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production,
Breadcrumbs: [
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet9_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production,
Breadcrumbs: [
Expand Down
3 changes: 1 addition & 2 deletions ...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet8_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Spans: [
{
Expand Down
3 changes: 1 addition & 2 deletions ...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet9_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Spans: [
{
Expand Down
6 changes: 2 additions & 4 deletions ....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
}
}
},
Expand All @@ -46,8 +45,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Breadcrumbs: [
{
Expand Down
6 changes: 2 additions & 4 deletions ....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet9_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
}
}
},
Expand All @@ -46,8 +45,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Breadcrumbs: [
{
Expand Down
6 changes: 2 additions & 4 deletions ...try.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
}
}
},
Expand All @@ -46,8 +45,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Breadcrumbs: [
{
Expand Down
6 changes: 2 additions & 4 deletions test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
}
}
},
Expand All @@ -46,8 +45,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Breadcrumbs: [
{
Expand Down
6 changes: 2 additions & 4 deletions test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production
}
Expand All @@ -47,8 +46,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production,
Breadcrumbs: [
Expand Down
6 changes: 2 additions & 4 deletions test/Sentry.Log4Net.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down Expand Up @@ -75,8 +74,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.Log4Net.Tests/IntegrationTests.Simple.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.NLog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.Serilog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.Tests/EventProcessorTests.Simple.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.Tests/EventProcessorTests.WithTransaction.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
6 changes: 2 additions & 4 deletions ...vent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet8_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production
}
Expand Down Expand Up @@ -177,8 +176,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production,
IsFinished: true
Expand Down
6 changes: 2 additions & 4 deletions ...vent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet9_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production
}
Expand Down Expand Up @@ -177,8 +176,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production,
IsFinished: true
Expand Down
6 changes: 2 additions & 4 deletions ...reEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.Net4_8.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production
}
Expand Down Expand Up @@ -177,8 +176,7 @@
}
},
User: {
Id: Guid_1,
IpAddress: {{auto}}
Id: Guid_1
},
Environment: production,
IsFinished: true
Expand Down
4 changes: 2 additions & 2 deletions test/Sentry.Tests/Internals/MainSentryEventProcessorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public void Process_SendDefaultPiiTrueAndUserIpSet_UserIpIgnoreServerInferredIp(
}

[Fact]
public void Process_SendDefaultPiiFalse_UserIpAuto()
public void Process_SendDefaultPiiFalse_UserIpUserIpNotSet()
{
//Arrange
var evt = new SentryEvent();
Expand All @@ -143,7 +143,7 @@ public void Process_SendDefaultPiiFalse_UserIpAuto()
_ = sut.Process(evt);

//Assert
evt.User.IpAddress.Should().Be(Enricher.DefaultIpAddress);
evt.User.IpAddress.Should().Be(null);
}

[Fact]
Expand Down
3 changes: 1 addition & 2 deletions test/Sentry.Tests/TransactionProcessorTests.Discard.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down
6 changes: 2 additions & 4 deletions test/Sentry.Tests/TransactionProcessorTests.Simple.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production
}
Expand Down Expand Up @@ -85,8 +84,7 @@
}
},
User: {
Id: Guid_3,
IpAddress: {{auto}}
Id: Guid_3
},
Environment: production,
IsFinished: true
Expand Down
Loading