Default User.IpAddress to {{auto}} (#2981)

getsentry · Dec 22, 2023 · cc2a691 · cc2a691
1 parent a826783
commit cc2a691
Show file tree

Hide file tree

Showing 28 changed files with 133 additions and 50 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Significant change in behavior
+
+- The User.IpAddress is now set to {{auto}} by default, even when sendDefaultPII is disabled ([#2981](https://github.com/getsentry/sentry-dotnet/pull/2981))
+  - The "Prevent Storing of IP Addresses" option in the "Security & Privacy" project settings on sentry.io can be used to control this instead
+
 ### Dependencies
 
 - Bump Cocoa SDK from v8.17.1 to v8.17.2 ([#2972](https://github.com/getsentry/sentry-dotnet/pull/2972))

diff --git a/src/Sentry/Internal/Enricher.cs b/src/Sentry/Internal/Enricher.cs
@@ -6,6 +6,8 @@ namespace Sentry.Internal;
 
 internal class Enricher
 {
+    internal const string DefaultIpAddress = "{{auto}}";
+
     private readonly SentryOptions _options;
 
     private readonly Lazy<Runtime> _runtimeLazy = new(() =>
@@ -74,15 +76,11 @@ 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.SendDefaultPii)
+        if (_options is { SendDefaultPii: true, IsEnvironmentUser: true } && !eventLike.HasUser())
         {
-            if (_options.IsEnvironmentUser && !eventLike.HasUser())
-            {
-                eventLike.User.Username = Environment.UserName;
-            }
-
-            eventLike.User.IpAddress ??= "{{auto}}";
+            eventLike.User.Username = Environment.UserName;
         }
+        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.DotNet6_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet6_0.verified.txt
@@ -23,7 +23,9 @@
             IsSampled: true
           }
         },
-        User: {},
+        User: {
+          IpAddress: {{auto}}
+        },
         Environment: production,
         Breadcrumbs: [
           {

diff --git a/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet7_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet7_0.verified.txt
@@ -23,7 +23,9 @@
             IsSampled: true
           }
         },
-        User: {},
+        User: {
+          IpAddress: {{auto}}
+        },
         Environment: production,
         Breadcrumbs: [
           {

diff --git a/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt
@@ -23,7 +23,9 @@
             IsSampled: true
           }
         },
-        User: {},
+        User: {
+          IpAddress: {{auto}}
+        },
         Environment: production,
         Breadcrumbs: [
           {

diff --git a/...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet6_0.verified.txt b/...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet6_0.verified.txt
@@ -21,7 +21,9 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           Operation: 
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Breadcrumbs: [
         {
           Message: Entity Framework Core  initialized 'TestDbContext' using provider 'Microsoft.EntityFrameworkCore.SqlServer:' with options: NoTracking ,
@@ -66,7 +68,9 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();,
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet7_0.verified.txt b/...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet7_0.verified.txt
@@ -21,7 +21,9 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           Operation: 
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Breadcrumbs: [
         {
           Message: Entity Framework Core  initialized 'TestDbContext' using provider 'Microsoft.EntityFrameworkCore.SqlServer:' with options: NoTracking ,
@@ -66,7 +68,9 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();,
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet8_0.verified.txt b/...ry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet8_0.verified.txt
@@ -17,7 +17,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet6_0.verified.txt b/....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet6_0.verified.txt
@@ -21,7 +21,9 @@
           Operation: 
         }
       },
-      User: {}
+      User: {
+        IpAddress: {{auto}}
+      }
     }
   },
   {
@@ -42,7 +44,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet7_0.verified.txt b/....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet7_0.verified.txt
@@ -21,7 +21,9 @@
           Operation: 
         }
       },
-      User: {}
+      User: {
+        IpAddress: {{auto}}
+      }
     }
   },
   {
@@ -42,7 +44,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt b/....DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt
@@ -21,7 +21,9 @@
           Operation: 
         }
       },
-      User: {}
+      User: {
+        IpAddress: {{auto}}
+      }
     }
   },
   {
@@ -42,7 +44,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/...try.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt b/...try.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt
@@ -21,7 +21,9 @@
           Operation: 
         }
       },
-      User: {}
+      User: {
+        IpAddress: {{auto}}
+      }
     }
   },
   {
@@ -42,7 +44,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt
@@ -21,7 +21,9 @@
           Operation: 
         }
       },
-      User: {}
+      User: {
+        IpAddress: {{auto}}
+      }
     }
   },
   {
@@ -42,7 +44,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Spans: [
         {
           IsFinished: true,

diff --git a/test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt b/test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt
@@ -21,7 +21,9 @@
           Operation: 
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Environment: production
     }
   },
@@ -43,7 +45,9 @@
           IsSampled: true
         }
       },
-      User: {},
+      User: {
+        IpAddress: {{auto}}
+      },
       Environment: production,
       Spans: [
         {

diff --git a/test/Sentry.Log4Net.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt b/test/Sentry.Log4Net.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
@@ -32,7 +32,9 @@
                   Operation: 
                 }
               },
-              User: {},
+              User: {
+                IpAddress: {{auto}}
+              },
               Environment: production
             }
           }
@@ -71,7 +73,9 @@
                   Operation: 
                 }
               },
-              User: {},
+              User: {
+                IpAddress: {{auto}}
+              },
               Environment: production
             }
           }

diff --git a/test/Sentry.Log4Net.Tests/IntegrationTests.Simple.verified.txt b/test/Sentry.Log4Net.Tests/IntegrationTests.Simple.verified.txt
@@ -31,7 +31,9 @@
                 Operation: 
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production
           }
         }

diff --git a/test/Sentry.NLog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
@@ -39,7 +39,9 @@
                   Operation: 
                 }
               },
-              User: {},
+              User: {
+                IpAddress: {{auto}}
+              },
               Environment: production
             }
           }

diff --git a/test/Sentry.Serilog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt b/test/Sentry.Serilog.Tests/IntegrationTests.LoggingInsideTheContextOfLogging.verified.txt
@@ -38,7 +38,9 @@
                   Operation: 
                 }
               },
-              User: {},
+              User: {
+                IpAddress: {{auto}}
+              },
               Environment: production
             }
           }

diff --git a/test/Sentry.Tests/EventProcessorTests.Simple.verified.txt b/test/Sentry.Tests/EventProcessorTests.Simple.verified.txt
@@ -31,7 +31,9 @@
                 Operation: 
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production
           }
         }

diff --git a/test/Sentry.Tests/EventProcessorTests.WithTransaction.verified.txt b/test/Sentry.Tests/EventProcessorTests.WithTransaction.verified.txt
@@ -35,7 +35,9 @@
                 Operation: 
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production
           }
         }

diff --git a/...vent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet6_0.verified.txt b/...vent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet6_0.verified.txt
@@ -111,7 +111,9 @@
                 Operation: 
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production
           }
         }
@@ -173,7 +175,9 @@
                 IsSampled: true
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production,
             IsFinished: true
           }

diff --git a/...vent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet7_0.verified.txt b/...vent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet7_0.verified.txt
@@ -111,7 +111,9 @@
                 Operation: 
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production
           }
         }
@@ -173,7 +175,9 @@
                 IsSampled: true
               }
             },
-            User: {},
+            User: {
+              IpAddress: {{auto}}
+            },
             Environment: production,
             IsFinished: true
           }