Merge pull request #217456 from kainawroth/patch-1

Stacyrch140 · web-flow · commit ded94f10b359 · 2022-12-09T19:02:56.000-05:00
Adding .NET 6 version of enabling and configuring sampling
diff --git a/articles/azure-monitor/app/sampling.md b/articles/azure-monitor/app/sampling.md
@@ -9,7 +9,7 @@ ms.reviewer: mmcc
 
 # Sampling in Application Insights
 
-Sampling is a feature in [Azure Application Insights](./app-insights-overview.md). It's the recommended way to reduce telemetry traffic, data costs, and storage costs, while preserving a statistically correct analysis of application data. Sampling also helps you avoid Application Insights throttling your telemetry. The sampling filter selects items that are related, so that you can navigate between items when you're doing diagnostic investigations.
+Sampling is a feature in [Application Insights](./app-insights-overview.md). It's the recommended way to reduce telemetry traffic, data costs, and storage costs, while preserving a statistically correct analysis of application data. Sampling also helps you avoid Application Insights throttling your telemetry. The sampling filter selects items that are related, so that you can navigate between items when you're doing diagnostic investigations.
 
 When metric counts are presented in the portal, they're renormalized to take into account sampling. Doing so minimizes any effect on the statistics.
 
@@ -139,7 +139,7 @@ In [`ApplicationInsights.config`](./configuration-with-applicationinsights-confi
 Instead of setting the sampling parameter in the `.config` file, you can programmatically set these values.
 
 1. Remove all the `AdaptiveSamplingTelemetryProcessor` node(s) from the `.config` file.
-2. Use the following snippet to configure adaptive sampling:
+1. Use the following snippet to configure adaptive sampling:
 
     ```csharp
     using Microsoft.ApplicationInsights;
@@ -179,21 +179,37 @@ Adaptive sampling is enabled by default for all ASP.NET Core applications. You c
 
 #### Turning off adaptive sampling
 
-The default sampling feature can be disabled while adding Application Insights service, in the method `ConfigureServices`, using `ApplicationInsightsServiceOptions` within the `Startup.cs` file:
+The default sampling feature can be disabled while adding the Application Insights service.
+
+### [ASP.NET Core 6 and later](#tab/net-core-new)
+
+Add `ApplicationInsightsServiceOptions` after the `WebApplication.CreateBuilder()` method in the `Program.cs` file:
+
+```csharp
+var builder = WebApplication.CreateBuilder(args);
+
+var aiOptions = new Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions();
+aiOptions.EnableAdaptiveSampling = false;
+builder.Services.AddApplicationInsightsTelemetry(aiOptions);
+
+var app = builder.Build();
+```
+
+### [ASP.NET Core 5 and earlier](#tab/net-core-old)
+
+Add `ApplicationInsightsServiceOptions` to the `ConfigureServices()` method in the `Startup.cs` file:
 
 ```csharp
 public void ConfigureServices(IServiceCollection services)
 {
-    // ...
-
     var aiOptions = new Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions();
     aiOptions.EnableAdaptiveSampling = false;
     services.AddApplicationInsightsTelemetry(aiOptions);
-
-    //...
 }
 ```
 
+---
+
 The above code will disable adaptive sampling. Follow the steps below to add sampling with more customization options.
 
 #### Configure sampling settings
@@ -203,6 +219,39 @@ Use extension methods of `TelemetryProcessorChainBuilder` as shown below to cust
 > [!IMPORTANT]
 > If you use this method to configure sampling, please make sure to set the `aiOptions.EnableAdaptiveSampling` property to `false` when calling `AddApplicationInsightsTelemetry()`. After making this change, you then need to follow the instructions in the code block below **exactly** in order to re-enable adaptive sampling with your customizations in place. Failure to do so can result in excess data ingestion. Always test post changing sampling settings, and set an appropriate [daily data cap](../logs/daily-cap.md) to help control your costs.
 
+### [ASP.NET Core 6 and later](#tab/net-core-new)
+
+```csharp
+using Microsoft.ApplicationInsights.AspNetCore.Extensions;
+using Microsoft.ApplicationInsights.Extensibility;
+
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services.Configure<TelemetryConfiguration>(telemetryConfiguration =>
+{
+    var builder = telemetryConfiguration.DefaultTelemetrySink.TelemetryProcessorChainBuilder;
+
+    // Using adaptive sampling
+    builder.UseAdaptiveSampling(maxTelemetryItemsPerSecond: 5);
+
+    // Alternately, the following configures adaptive sampling with 5 items per second, and also excludes DependencyTelemetry from being subject to sampling:
+    // configuration.DefaultTelemetrySink.TelemetryProcessorChainBuilder.UseAdaptiveSampling(maxTelemetryItemsPerSecond:5, excludedTypes: "Dependency");
+
+    // If you have other telemetry processors:
+    builder.Use(next => new AnotherProcessor(next));
+
+});
+
+builder.Services.AddApplicationInsightsTelemetry(new ApplicationInsightsServiceOptions
+{
+    EnableAdaptiveSampling = false,
+});
+
+var app = builder.Build();
+```
+
+### [ASP.NET Core 5 and earlier](#tab/net-core-old)
+
 ```csharp
 using Microsoft.ApplicationInsights.Extensibility
 
@@ -222,11 +271,11 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, Telemetr
     builder.Use((next) => new AnotherProcessor(next));
     
     builder.Build();
-
-    // ...
 }
 ```
 
+---
+
 ### Configuring adaptive sampling for Azure Functions
 
 Follow instructions from [this page](../../azure-functions/configure-monitoring.md#configure-sampling) to configure adaptive sampling for apps running in Azure Functions.
@@ -252,7 +301,7 @@ In Metrics Explorer, rates such as request and exception counts are multiplied b
         -->
     ```
 
-2. **Enable the fixed-rate sampling module.** Add this snippet to [`ApplicationInsights.config`](./configuration-with-applicationinsights-config.md):
+1. **Enable the fixed-rate sampling module.** Add this snippet to [`ApplicationInsights.config`](./configuration-with-applicationinsights-config.md):
    
     ```xml
     <TelemetryProcessors>
@@ -264,8 +313,8 @@ In Metrics Explorer, rates such as request and exception counts are multiplied b
     </TelemetryProcessors>
     ```
 
-      Alternatively, instead of setting the sampling parameter in the `ApplicationInsights.config` file, you can programmatically set these values:
-
+    Alternatively, instead of setting the sampling parameter in the `ApplicationInsights.config` file, you can programmatically set these values:
+    
     ```csharp
     using Microsoft.ApplicationInsights.Extensibility;
     using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel;
@@ -288,22 +337,66 @@ In Metrics Explorer, rates such as request and exception counts are multiplied b
 
 ### Configuring fixed-rate sampling for ASP.NET Core applications
 
-1. **Disable adaptive sampling**:  Changes can be made in the `ConfigureServices` method, using `ApplicationInsightsServiceOptions`:
+1. **Disable adaptive sampling**
+
+    ### [ASP.NET Core 6 and later](#tab/net-core-new)
+    
+    Changes can be made after the `WebApplication.CreateBuilder()` method, using `ApplicationInsightsServiceOptions`:
+    
+    ```csharp
+    var builder = WebApplication.CreateBuilder(args);
+
+    var aiOptions = new Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions();
+    aiOptions.EnableAdaptiveSampling = false;
+    builder.Services.AddApplicationInsightsTelemetry(aiOptions);
+    
+    var app = builder.Build();
+    ```
+
+    ### [ASP.NET Core 5 and earlier](#tab/net-core-old)
+    
+    Changes can be made in the `ConfigureServices()` method, using `ApplicationInsightsServiceOptions`:
 
     ```csharp
     public void ConfigureServices(IServiceCollection services)
     {
-        // ...
-
         var aiOptions = new Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions();
         aiOptions.EnableAdaptiveSampling = false;
         services.AddApplicationInsightsTelemetry(aiOptions);
-
-        //...
     }
     ```
+    
+    ---
+
+1. **Enable the fixed-rate sampling module**
+
+    ### [ASP.NET Core 6 and later](#tab/net-core-new)
+    
+    Changes can be made after the `WebApplication.CreateBuilder()` method:
+    
+    ```csharp
+    var builder = WebApplication.CreateBuilder(args);
+
+    builder.Services.Configure<TelemetryConfiguration>(telemetryConfiguration =>
+    {
+        var builder = telemetryConfiguration.DefaultTelemetrySink.TelemetryProcessorChainBuilder;
+    
+        // Using fixed rate sampling
+        double fixedSamplingPercentage = 10;
+        builder.UseSampling(fixedSamplingPercentage);
+    });
+    
+    builder.Services.AddApplicationInsightsTelemetry(new ApplicationInsightsServiceOptions
+    {
+        EnableAdaptiveSampling = false,
+    });
+
+    var app = builder.Build(); 
+    ```
 
-2. **Enable the fixed-rate sampling module.** Changes can be made in the `Configure` method as shown in the below snippet:
+    ### [ASP.NET Core 5 and earlier](#tab/net-core-old)
+    
+    Changes can be made in the `Configure()` method:
 
     ```csharp
     public void Configure(IApplicationBuilder app, IHostingEnvironment env)
@@ -319,11 +412,11 @@ In Metrics Explorer, rates such as request and exception counts are multiplied b
         builder.UseSampling(fixedSamplingPercentage);
 
         builder.Build();
-
-        // ...
     }
     ```
 
+    ---
+
 ### Configuring sampling overrides and fixed-rate sampling for Java applications
 
 By default no sampling is enabled in the Java auto-instrumentation and SDK. Currently the Java auto-instrumentation, [sampling overrides](./java-standalone-sampling-overrides.md) and fixed rate sampling are supported. Adaptive sampling isn't supported in Java.
