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

bitsandfoxes · jamescrosswell · web-flow · commit b31e4db47bab · 2025-01-28T14:02:12.000+13:00
Co-authored-by: James Crosswell &lt;jamescrosswell@users.noreply.github.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -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))
diff --git a/src/Sentry/Internal/Enricher.cs b/src/Sentry/Internal/Enricher.cs
@@ -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;
diff --git a/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt
@@ -26,8 +26,7 @@
           }
         },
         User: {
-          Id: Guid_1,
-          IpAddress: {{auto}}
+          Id: Guid_1
         },
         Environment: production,
         Breadcrumbs: [
diff --git a/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet9_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet9_0.verified.txt
@@ -26,8 +26,7 @@
           }
         },
         User: {
-          Id: Guid_1,
-          IpAddress: {{auto}}
+          Id: Guid_1
         },
         Environment: production,
         Breadcrumbs: [
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet8_0.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet8_0.verified.txt
@@ -18,8 +18,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Spans: [
         {
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet9_0.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet9_0.verified.txt
@@ -18,8 +18,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Spans: [
         {
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt
@@ -22,8 +22,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       }
     }
   },
@@ -46,8 +45,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Breadcrumbs: [
         {
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet9_0.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet9_0.verified.txt
@@ -22,8 +22,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       }
     }
   },
@@ -46,8 +45,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Breadcrumbs: [
         {
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt
@@ -22,8 +22,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       }
     }
   },
@@ -46,8 +45,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Breadcrumbs: [
         {
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt
@@ -22,8 +22,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       }
     }
   },
@@ -46,8 +45,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Breadcrumbs: [
         {
diff --git a/test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt b/test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt
@@ -22,8 +22,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Environment: production
     }
@@ -47,8 +46,7 @@
         }
       },
       User: {
-        Id: Guid_1,
-        IpAddress: {{auto}}
+        Id: Guid_1
       },
       Environment: production,
       Breadcrumbs: [
diff --git a/test/Sentry.Log4Net.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt b/test/Sentry.Log4Net.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
@@ -33,8 +33,7 @@
                 }
               },
               User: {
-                Id: Guid_3,
-                IpAddress: {{auto}}
+                Id: Guid_3
               },
               Environment: production
             }
@@ -75,8 +74,7 @@
                 }
               },
               User: {
-                Id: Guid_3,
-                IpAddress: {{auto}}
+                Id: Guid_3
               },
               Environment: production
             }
diff --git a/test/Sentry.Log4Net.Tests/IntegrationTests.Simple.verified.txt b/test/Sentry.Log4Net.Tests/IntegrationTests.Simple.verified.txt
@@ -32,8 +32,7 @@
               }
             },
             User: {
-              Id: Guid_3,
-              IpAddress: {{auto}}
+              Id: Guid_3
             },
             Environment: production
           }
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
@@ -40,8 +40,7 @@
                 }
               },
               User: {
-                Id: Guid_3,
-                IpAddress: {{auto}}
+                Id: Guid_3
               },
               Environment: production
             }
diff --git a/test/Sentry.Serilog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt b/test/Sentry.Serilog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
@@ -39,8 +39,7 @@
                 }
               },
               User: {
-                Id: Guid_3,
-                IpAddress: {{auto}}
+                Id: Guid_3
               },
               Environment: production
             }
diff --git a/test/Sentry.Tests/EventProcessorTests.Simple.verified.txt b/test/Sentry.Tests/EventProcessorTests.Simple.verified.txt
@@ -32,8 +32,7 @@
               }
             },
             User: {
-              Id: Guid_3,
-              IpAddress: {{auto}}
+              Id: Guid_3
             },
             Environment: production
           }
diff --git a/test/Sentry.Tests/EventProcessorTests.WithTransaction.verified.txt b/test/Sentry.Tests/EventProcessorTests.WithTransaction.verified.txt
@@ -36,8 +36,7 @@
               }
             },
             User: {
-              Id: Guid_3,
-              IpAddress: {{auto}}
+              Id: Guid_3
             },
             Environment: production
           }
diff --git a/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet8_0.verified.txt b/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet8_0.verified.txt
@@ -112,8 +112,7 @@
               }
             },
             User: {
-              Id: Guid_1,
-              IpAddress: {{auto}}
+              Id: Guid_1
             },
             Environment: production
           }
@@ -177,8 +176,7 @@
               }
             },
             User: {
-              Id: Guid_1,
-              IpAddress: {{auto}}
+              Id: Guid_1
             },
             Environment: production,
             IsFinished: true
diff --git a/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet9_0.verified.txt b/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet9_0.verified.txt
@@ -112,8 +112,7 @@
               }
             },
             User: {
-              Id: Guid_1,
-              IpAddress: {{auto}}
+              Id: Guid_1
             },
             Environment: production
           }
@@ -177,8 +176,7 @@
               }
             },
             User: {
-              Id: Guid_1,
-              IpAddress: {{auto}}
+              Id: Guid_1
             },
             Environment: production,
             IsFinished: true
diff --git a/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.Net4_8.verified.txt b/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.Net4_8.verified.txt
@@ -112,8 +112,7 @@
               }
             },
             User: {
-              Id: Guid_1,
-              IpAddress: {{auto}}
+              Id: Guid_1
             },
             Environment: production
           }
@@ -177,8 +176,7 @@
               }
             },
             User: {
-              Id: Guid_1,
-              IpAddress: {{auto}}
+              Id: Guid_1
             },
             Environment: production,
             IsFinished: true
diff --git a/test/Sentry.Tests/Internals/MainSentryEventProcessorTests.cs b/test/Sentry.Tests/Internals/MainSentryEventProcessorTests.cs
@@ -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();
@@ -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]
diff --git a/test/Sentry.Tests/TransactionProcessorTests.Discard.verified.txt b/test/Sentry.Tests/TransactionProcessorTests.Discard.verified.txt
@@ -35,8 +35,7 @@
               }
             },
             User: {
-              Id: Guid_3,
-              IpAddress: {{auto}}
+              Id: Guid_3
             },
             Environment: production
           }
diff --git a/test/Sentry.Tests/TransactionProcessorTests.Simple.verified.txt b/test/Sentry.Tests/TransactionProcessorTests.Simple.verified.txt
@@ -35,8 +35,7 @@
               }
             },
             User: {
-              Id: Guid_3,
-              IpAddress: {{auto}}
+              Id: Guid_3
             },
             Environment: production
           }
@@ -85,8 +84,7 @@
               }
             },
             User: {
-              Id: Guid_3,
-              IpAddress: {{auto}}
+              Id: Guid_3
             },
             Environment: production,
             IsFinished: true

Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,7 @@`
`18`	`18`	`}`
`19`	`19`	`},`
`20`	`20`	`User: {`
`21`		`- Id: Guid_1,`
`22`		`- IpAddress: {{auto}}`
	`21`	`+ Id: Guid_1`
`23`	`22`	`},`
`24`	`23`	`Spans: [`
`25`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,7 @@`
`22`	`22`	`}`
`23`	`23`	`},`
`24`	`24`	`User: {`
`25`		`- Id: Guid_1,`
`26`		`- IpAddress: {{auto}}`
	`25`	`+ Id: Guid_1`
`27`	`26`	`}`
`28`	`27`	`}`
`29`	`28`	`},`
`@@ -46,8 +45,7 @@`
`46`	`45`	`}`
`47`	`46`	`},`
`48`	`47`	`User: {`
`49`		`- Id: Guid_1,`
`50`		`- IpAddress: {{auto}}`
	`48`	`+ Id: Guid_1`
`51`	`49`	`},`
`52`	`50`	`Breadcrumbs: [`
`53`	`51`	`{`