.NET housekeeping (#7477)

bitsandfoxes · web-flow · commit 701f5699530c · 2023-07-24T10:13:17.000+02:00
diff --git a/src/platform-includes/configuration/config-intro/dotnet.mdx b/src/platform-includes/configuration/config-intro/dotnet.mdx
@@ -1,4 +1,4 @@
-Options can be set from a function provided to the `SentrySdk.Init` method. For example:
+For example, initialize with `SentrySdk.Init` in your `Program.cs` file:
 
 <SignInNote />
 
@@ -15,19 +15,27 @@ SentrySdk.Init(options =>
     // When debug is enabled, the Sentry client will emit detailed debugging information to the console.
     // This might be helpful, or might interfere with the normal operation of your application.
     // We enable it here for demonstration purposes when first trying Sentry.
-    // You should not do this in your applications unless you are troubleshooting issues with Sentry.
+    // You shouldn't do this in your applications unless you're troubleshooting issues with Sentry.
     options.Debug = true;
 
-    // This option is recommended, which enables Sentry's "Release Health" feature.
+    // This option is recommended. It enables Sentry's "Release Health" feature.
     options.AutoSessionTracking = true;
 
-    // This option is recommended for client applications only. It ensures all threads use the same global scope.
-    // If you are writing a background service of any kind, you should remove this.
-    options.IsGlobalModeEnabled = true;
+    // Enabling this option is recommended for client applications only. It ensures all threads use the same global scope.
+    options.IsGlobalModeEnabled = false;
 
     // This option will enable Sentry's tracing features. You still need to start transactions and spans.
     options.EnableTracing = true;
+
+    // Example sample rate for your transactions: captures 10% of transactions
+    options.TracesSampleRate = 0.1;
 });
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
+<Note>
+
+After you have configured Sentry in your code, you can also configure the
+[MSBuild setup](/platforms/dotnet/configuration/msbuild/) for your project. While this step is optional,
+it can greatly improve your Sentry experience.
+
+</Note>
diff --git a/src/platform-includes/enriching-events/breadcrumbs/before-breadcrumb/dotnet.mdx b/src/platform-includes/enriching-events/breadcrumbs/before-breadcrumb/dotnet.mdx
@@ -2,18 +2,18 @@
 using Sentry;
 
 // Add this to the SDK initialization callback
-options.BeforeBreadcrumb = breadcrumb
+options.SetBeforeBreadcrumb(breadcrumb
     // Ignore breadcrumbs from Spammy logger
     => breadcrumb.Category == "Spammy.Logger"
         ? null
-        : breadcrumb;
+        : breadcrumb);
 ```
 
 ```fsharp
 open Sentry
 
 // Add this to the SDK initialization callback
-options.BeforeBreadcrumb <- (fun breadcrumb ->
+options.SetBeforeBreadcrumb(fun breadcrumb ->
     // Ignore breadcrumbs from Spammy logger
     if breadcrumb.Category = "Spammy.Logger" then
         null
diff --git a/src/platform-includes/getting-started-config/dotnet.aspnet.mdx b/src/platform-includes/getting-started-config/dotnet.aspnet.mdx
@@ -25,9 +25,11 @@ namespace AspNetMvc
                 // Get ASP.NET integration
                 o.AddAspNet();
 
-                // Collect 100% traces for testing purposes
-                // (consider using a smaller value when running in production)
-                o.TracesSampleRate = 1.0;
+                // This option will enable Sentry's tracing features. You still need to start transactions and spans.
+                o.EnableTracing = true;
+
+                // Example sample rate for your transactions: captures 10% of transactions
+                o.TracesSampleRate = 0.1;
             });
         }
 
diff --git a/src/platform-includes/getting-started-config/dotnet.mdx b/src/platform-includes/getting-started-config/dotnet.mdx
@@ -21,13 +21,21 @@ SentrySdk.Init(options =>
     // This option is recommended. It enables Sentry's "Release Health" feature.
     options.AutoSessionTracking = true;
 
-    // This option is recommended for client applications only. It ensures all threads use the same global scope.
-    // If you're writing a background service of any kind, you should remove this.
-    options.IsGlobalModeEnabled = true;
+    // Enabling this option is recommended for client applications only. It ensures all threads use the same global scope.
+    options.IsGlobalModeEnabled = false;
 
     // This option will enable Sentry's tracing features. You still need to start transactions and spans.
     options.EnableTracing = true;
+
+    // Example sample rate for your transactions: captures 10% of transactions
+    options.TracesSampleRate = 0.1;
 });
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
+<Note>
+
+After you have configured Sentry in your code, you can also configure the
+[MSBuild setup](/platforms/dotnet/configuration/msbuild/) for your project. While this step is optional,
+it can greatly improve your Sentry experience.
+
+</Note>
diff --git a/src/platform-includes/getting-started-confignote/dotnet.mdx b/src/platform-includes/getting-started-confignote/dotnet.mdx
diff --git a/src/platform-includes/set-fingerprint/basic/dotnet.mdx b/src/platform-includes/set-fingerprint/basic/dotnet.mdx
@@ -1,19 +1,19 @@
 ```csharp
 // Add this to the SDK initialization callback
-options.BeforeSend = @event =>
+options.SetBeforeSend(@event =>
 {
     if (@event.Exception is SqlConnectionException ex)
     {
         @event.SetFingerprint(new [] { "database-connection-error" });
     }
 
     return @event;
-};
+});
 ```
 
 ```fsharp
 // Add this to the SDK initialization callback
-options.BeforeSend <- (fun event ->
+options.SetBeforeSend(fun event ->
     match event.Exception with
     | :? SqlConnectionException -> event.SetFingerprint(["database-connection-error"])
     | _ -> ()
diff --git a/src/platform-includes/set-fingerprint/database-connection/dotnet.mdx b/src/platform-includes/set-fingerprint/database-connection/dotnet.mdx
@@ -1,18 +1,18 @@
 ```csharp
 // Add this to the SDK initialization callback
-options.BeforeSend = @event =>
+options.SetBeforeSend(@event =>
 {
     if (@event.Exception is SqlConnectionException ex)
     {
         @event.SetFingerprint(new [] { "database-connection-error" });
     }
 
     return @event;
-};
+});
 ```
 
 ```fsharp
-options.BeforeSend <- (fun event ->
+options.SetBeforeSend(fun event ->
     match event.Exception with
     | :? SqlConnectionException -> event.SetFingerprint(["database-connection-error"])
     | _ -> ()
diff --git a/src/platform-includes/set-fingerprint/rpc/dotnet.mdx b/src/platform-includes/set-fingerprint/rpc/dotnet.mdx
@@ -9,7 +9,7 @@ public class MyRpcException : Exception
 }
 
 // Add this to the SDK initialization callback
-options.BeforeSend = @event =>
+options.SetBeforeSend(@event =>
 {
     if (@event.Exception is MyRpcException ex)
     {
@@ -24,7 +24,7 @@ options.BeforeSend = @event =>
     }
 
     return @event;
-};
+});
 ```
 
 ```fsharp
@@ -36,7 +36,7 @@ type MyRpcException() =
     member val Code: HttpStatusCode = HttpStatusCode.OK with get, set
 
 // Add this to the SDK initialization callback
-options.BeforeSend <- (fun event ->
+options.SetBeforeSend(fun event ->
     match event.Exception with
     | :? MyRpcException as ex -> event.SetFingerprint([
                 "{{ default }}"
diff --git a/src/platform-includes/set-fingerprint/rpc/dotnet.xamarin.mdx b/src/platform-includes/set-fingerprint/rpc/dotnet.xamarin.mdx
@@ -9,7 +9,7 @@ public class MyRpcException : Exception
 }
 
 // Add this to the SDK initialization callback
-options.BeforeSend = @event =>
+options.SetBeforeSend(@event =>
 {
     if (@event.Exception is MyRpcException ex)
     {
@@ -24,5 +24,5 @@ options.BeforeSend = @event =>
     }
 
     return @event;
-};
+});
 ```
diff --git a/src/platform-includes/set-fingerprint/static/dotnet.mdx b/src/platform-includes/set-fingerprint/static/dotnet.mdx
@@ -1,6 +1,6 @@
 ```csharp
 // Add this to the SDK initialization callback
-options.BeforeSend = @event =>
+options.SetBeforeSend(@event =>
 {
     @event.SetFingerprint(
         new []
@@ -10,12 +10,12 @@ options.BeforeSend = @event =>
     );
 
     return @event;
-};
+});
 ```
 
 ```fsharp
 // Add this to the SDK initialization callback
-options.BeforeSend <- (fun event ->
+options.SetBeforeSend(fun event ->
     event.SetFingerprint(["my-view-function"])
     event
     )
diff --git a/src/platforms/dotnet/guides/aspnet/index.mdx b/src/platforms/dotnet/guides/aspnet/index.mdx
@@ -31,7 +31,7 @@ using System;
 using System.Web;
 using Sentry;
 using Sentry.AspNet;
-using Sentry.EntityFramework; // if you also installed Sentry.EntityFramework
+using Sentry.EntityFramework; // If you also installed Sentry.EntityFramework
 using Sentry.Extensibility;
 
 public class MvcApplication : HttpApplication
@@ -46,11 +46,14 @@ public class MvcApplication : HttpApplication
             o.Dsn = "___PUBLIC_DSN___";
             // When configuring for the first time, to see what the SDK is doing:
             o.Debug = true;
-            // Set TracesSampleRate to 1.0 to capture 100%
-            // of transactions for performance monitoring.
-            // We recommend adjusting this value in production
-            o.TracesSampleRate = 1.0;
-            // if you also installed the Sentry.EntityFramework package
+
+            // This option will enable Sentry's tracing features. You still need to start transactions and spans.
+            o.EnableTracing = true;
+
+            // Example sample rate for your transactions: captures 10% of transactions
+            o.TracesSampleRate = 0.1;
+
+            // If you also installed the Sentry.EntityFramework package
             o.AddEntityFramework();
             o.AddAspNet();
         });
@@ -77,22 +80,17 @@ public class MvcApplication : HttpApplication
 }
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
-
 ### Capturing the affected user
 
 When opting-in to [SendDefaultPii](#senddefaultpii), the SDK will automatically read the user from the request by inspecting `HttpContext.User`. Default claim values like `NameIdentifier` for the _Id_ will be used.
 
 <SignInNote />
 
 ```csharp
-SentrySdk.Init(o =>
-{
-  o.AddAspNet();
-  o.Dsn = "___PUBLIC_DSN___";
-  // Opt-in to send things like UserId and UserName if a user is logged-in
-  o.SendDefaultPii = true;
-});
+options.AddAspNet();
+options.Dsn = "___PUBLIC_DSN___";
+// Opt-in to send things like UserId and UserName if a user is logged-in
+options.SendDefaultPii = true;
 ```
 
 ### SendDefaultPii
@@ -105,10 +103,7 @@ It's helpful to troubleshoot a problem in the API when the payload that hit the
 Opt-in to send the request body to Sentry:
 
 ```csharp
-SentrySdk.Init(o =>
-{
-  o.AddAspNet(RequestSize.Always);
-}
+options.AddAspNet(RequestSize.Always);
 ```
 
 ## Troubleshooting
diff --git a/src/platforms/dotnet/guides/aspnet/performance/included-instrumentation.mdx b/src/platforms/dotnet/guides/aspnet/performance/included-instrumentation.mdx
@@ -41,9 +41,12 @@ namespace AspNetMvc
 
                 // When configuring for the first time, to see what the SDK is doing:
                 o.Debug = true;
-                // Collect 100% traces for testing purposes
-                // (consider using a smaller value when running in production)
-                o.TracesSampleRate = 1.0;
+
+                // This option will enable Sentry's tracing features. You still need to start transactions and spans.
+                o.EnableTracing = true;
+
+                // Example sample rate for your transactions: captures 10% of transactions
+                o.TracesSampleRate = 0.1;
             });
         }
 
diff --git a/src/platforms/dotnet/guides/aspnetcore/index.mdx b/src/platforms/dotnet/guides/aspnetcore/index.mdx
@@ -176,18 +176,18 @@ Some of the settings require actual code. For those, like the `BeforeSend` callb
 ```csharp
 .UseSentry(options =>
 {
-    options.BeforeSend = @event =>
+    options.SetBeforeSend(@event =>
     {
         // Never report server names
         @event.ServerName = null;
         return @event;
-    };
+    });
 })
 ```
 
 ```fsharp
 .UseSentry (fun options ->
-    options.BeforeSend <- (fun event ->
+    options.SetBeforeSend(fun event ->
         // Never report server names
         event.ServerName <- null
         event
@@ -241,8 +241,6 @@ member this.ConfigureServices(services: IServiceCollection) =
     services.AddScoped<ISentryEventExceptionProcessor, MyExceptionProcessor>() |> ignore
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
-
 ## Options and Initialization
 
 As previously mentioned, this package is a wrapper around [Sentry.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/) and [Sentry](/platforms/dotnet/). Please refer to the documentation of these packages to get the options that are defined at those levels.
diff --git a/src/platforms/dotnet/guides/aws-lambda/index.mdx b/src/platforms/dotnet/guides/aws-lambda/index.mdx
@@ -51,8 +51,6 @@ public class LambdaEntryPoint : Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFu
 }
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
-
 Check out the [Sentry ASP.NET Core](/platforms/dotnet/guides/aspnetcore/) documentation for the complete set of options.
 
 ## Samples
diff --git a/src/platforms/dotnet/guides/google-cloud-functions/index.mdx b/src/platforms/dotnet/guides/google-cloud-functions/index.mdx
@@ -114,11 +114,11 @@ public class CustomOptions : FunctionsStartup
         base.ConfigureServices(context, services);
         services.Configure<SentryAspNetCoreOptions>(options =>
         {
-            options.BeforeSend = @event =>
+            options.SetBeforeSend(@event =>
             {
                 @event.ServerName = null;
                 return @event;
-            };
+            });
         });
     }
 }
@@ -154,8 +154,6 @@ public class UserFactoryStartup : FunctionsStartup
 }
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
-
 ## Options & Initialization
 
 As previously mentioned, this package is a wrapper around [Sentry.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/), [Sentry.AspNetCore](/platforms/dotnet/guides/aspnetcore/) and [Sentry](/platforms/dotnet/). Please refer to the documentation of these packages to get the options that are defined at those levels.
diff --git a/src/platforms/dotnet/guides/maui/index.mdx b/src/platforms/dotnet/guides/maui/index.mdx
@@ -71,8 +71,6 @@ public static MauiApp CreateMauiApp()
 }
 ```
 
-<PlatformContent includePath="getting-started-confignote" />
-
 ## Options
 
 As previously mentioned, this package is a wrapper around [Sentry.Extensions.Logging](/platforms/dotnet/guides/extensions-logging/) and [Sentry](/platforms/dotnet/). Please refer to the documentation of these packages to get the options that are defined at those levels.
diff --git a/src/platforms/dotnet/guides/uwp/index.mdx b/src/platforms/dotnet/guides/uwp/index.mdx
@@ -96,5 +96,3 @@ sealed partial class App : Application
     }
 }
 ```
-
-<PlatformContent includePath="getting-started-confignote" />
diff --git a/src/platforms/dotnet/guides/winforms/index.mdx b/src/platforms/dotnet/guides/winforms/index.mdx
@@ -11,8 +11,6 @@ Sentry's .NET SDK works with WinForms applications through the [Sentry NuGet pac
 
 After adding the NuGet package, the SDK should be initialized in the program's main entry point, before launching any forms or performing signifanct work. The options for initialization vary by language.
 
-<PlatformContent includePath="getting-started-confignote" />
-
 ### C# Initialization
 
 A C# Windows Forms application will have a `Program.cs` file. You should initialize Sentry in this file.
diff --git a/src/platforms/dotnet/guides/wpf/index.mdx b/src/platforms/dotnet/guides/wpf/index.mdx
@@ -57,5 +57,3 @@ public partial class App : Application
     }
 }
 ```
-
-<PlatformContent includePath="getting-started-confignote" />
diff --git a/src/platforms/dotnet/guides/xamarin/index.mdx b/src/platforms/dotnet/guides/xamarin/index.mdx
diff --git a/src/platforms/dotnet/migration.mdx b/src/platforms/dotnet/migration.mdx

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public class MyRpcException : Exception`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`// Add this to the SDK initialization callback`
`12`		`-options.BeforeSend = @event =>`
	`12`	`+options.SetBeforeSend(@event =>`
`13`	`13`	`{`
`14`	`14`	`if (@event.Exception is MyRpcException ex)`
`15`	`15`	`{`
`@@ -24,7 +24,7 @@ options.BeforeSend = @event =>`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`return @event;`
`27`		`-};`
	`27`	`+});`
`28`	`28`	```
`29`	`29`
`30`	`30`	```fsharp
`@@ -36,7 +36,7 @@ type MyRpcException() =`
`36`	`36`	`member val Code: HttpStatusCode = HttpStatusCode.OK with get, set`
`37`	`37`
`38`	`38`	`// Add this to the SDK initialization callback`
`39`		`-options.BeforeSend <- (fun event ->`
	`39`	`+options.SetBeforeSend(fun event ->`
`40`	`40`	`match event.Exception with`
`41`	`41`	`\| :? MyRpcException as ex -> event.SetFingerprint([`
`42`	`42`	`"{{ default }}"`