Adjusts example to use middleware and initializer for targeting id (#357)

rossgrambo · web-flow · commit a853c10d5b13 · 2024-02-01T10:29:33.000-08:00
* Adjusts example to use middleware and initializer for targeting id

* Update examples/EvaluationDataToApplicationInsights/README.md
diff --git a/examples/EvaluationDataToApplicationInsights/EvaluationDataToApplicationInsights.csproj b/examples/EvaluationDataToApplicationInsights/EvaluationDataToApplicationInsights.csproj
@@ -12,6 +12,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\Microsoft.FeatureManagement.AspNetCore\Microsoft.FeatureManagement.AspNetCore.csproj" />
+    <ProjectReference Include="..\..\src\Microsoft.FeatureManagement.Telemetry.ApplicationInsights.AspNetCore\Microsoft.FeatureManagement.Telemetry.ApplicationInsights.AspNetCore.csproj" />
     <ProjectReference Include="..\..\src\Microsoft.FeatureManagement.Telemetry.ApplicationInsights\Microsoft.FeatureManagement.Telemetry.ApplicationInsights.csproj" />
   </ItemGroup>
 
diff --git a/examples/EvaluationDataToApplicationInsights/HttpContextTargetingContextAccessor.cs b/examples/EvaluationDataToApplicationInsights/HttpContextTargetingContextAccessor.cs
@@ -29,6 +29,8 @@ public ValueTask<TargetingContext> GetContextAsync()
                 return new ValueTask<TargetingContext>((TargetingContext)value);
             }
 
+            //
+            // Grab username from cookie
             string username = httpContext.Request.Cookies["username"];
 
             var groups = new List<string>();
diff --git a/examples/EvaluationDataToApplicationInsights/Pages/Checkout.cshtml b/examples/EvaluationDataToApplicationInsights/Pages/Checkout.cshtml
@@ -7,6 +7,14 @@
 
 <p>Click Below To Check Out!</p>
 
-<button id="checkout" name="checkout" onclick="appInsights.trackEvent({ name: 'checkout', properties: { 'success' : 'yes' } }); appInsights.trackMetric({ name: 'checkoutAmount', average: Math.floor(Math.random() * 100) }); alert('Checked Out!');">
+<script>
+    function checkOut() {
+        appInsights.trackEvent({ name: 'checkout', properties: { 'success': 'yes' } });
+        appInsights.trackMetric({ name: 'checkoutAmount', average: Math.floor(Math.random() * 100) });
+        alert('Checked Out!');
+    }
+</script>
+
+<button id="checkout" name="checkout" onclick="checkOut()">
     Check Out
-</button>
+</button>
diff --git a/examples/EvaluationDataToApplicationInsights/Pages/Shared/_Layout.cshtml b/examples/EvaluationDataToApplicationInsights/Pages/Shared/_Layout.cshtml
@@ -20,9 +20,6 @@
     <script src="~/lib/jquery/dist/jquery.min.js"></script>
     <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
     <script src="~/js/site.js" asp-append-version="true"></script>
-    <script>
-        appInsights.setAuthenticatedUserContext(@username);
-    </script>
 </head>
 <body>
     <header>
diff --git a/examples/EvaluationDataToApplicationInsights/Program.cs b/examples/EvaluationDataToApplicationInsights/Program.cs
@@ -2,10 +2,10 @@
 // Licensed under the MIT license.
 //
 using Microsoft.FeatureManagement.Telemetry.ApplicationInsights;
-using EvaluationDataToApplicationInsights.Telemetry;
 using Microsoft.FeatureManagement;
 using EvaluationDataToApplicationInsights;
 using Microsoft.ApplicationInsights.Extensibility;
+using Microsoft.FeatureManagement.Telemetry.ApplicationInsights.AspNetCore;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -20,8 +20,8 @@
 builder.Services.AddApplicationInsightsTelemetry();
 
 //
-// App Insights User Tagging
-builder.Services.AddSingleton<ITelemetryInitializer, MyTelemetryInitializer>();
+// App Insights TargetingId Tagging
+builder.Services.AddSingleton<ITelemetryInitializer, TargetingTelemetryInitializer>();
 
 //
 // Enter feature management
@@ -55,4 +55,8 @@
 
 app.MapRazorPages();
 
+//
+// Adds Targeting Id to HttpContext
+app.UseMiddleware<TargetingHttpContextMiddleware>();
+
 app.Run();
diff --git a/examples/EvaluationDataToApplicationInsights/README.md b/examples/EvaluationDataToApplicationInsights/README.md
@@ -46,23 +46,10 @@ These cookies are used to correlate telemetry from the browser with telemetry fr
 
 *The Javascript SDK is not required, but is useful for collecting browser telemetry and generating these cookies out of the box.*
 
-### Authenticated User ID
-In order to connect metrics for the user between multiple services, a Authenticated User Id needs to be emitted. When the application is loaded, a login is simulated by setting a "username" cookie to a random integer. Additionally, the "ai_user" and "ai_session" cookies are expired, to simulate a new browser.
+### Targeting Id
+In order to connect evaluation events with other metrics from the user, a targeting id needs to be emitted. This can be done multiple ways, but the recommended way is to define a telemetry initializer. This initializer allows the app to modify all telemetry going to Application Insights before it's sent. 
 
-To include the authenticated user id on metrics emitted from the Javascript SDK, this app adds the following to _Layout.cshtml:
-```html
-appInsights.setAuthenticatedUserContext(getCookie("username"));
-```
-
-To include it on metrics emitted from the ASP.NET SDK, this app uses a TelemetryInitializer named `MyTelemetryInitializer`:
-```csharp
-builder.Services.AddSingleton<ITelemetryInitializer, MyTelemetryInitializer>();
-```
-
-The initializer sets the Authenticated User on the context object for all telemetry emitted from the server:
-```csharp
-telemetry.Context.User.AuthenticatedUserId = username;
-```
+This example uses the provided `TargetingHttpContextMiddleware` and `TargetingTelemetryInitializer`. The middleware adds `TargetingId` (using the targeting context accessor) to the HTTP Context as a request comes in. The initializer checks for the `TargetingId` on the HTTP Context, and if it exists, adds `TargetingId` to all outgoing Application Insights Telemetry.
 
 ## Sample App Usage
 Sample steps to try out the app:
diff --git a/examples/EvaluationDataToApplicationInsights/Telemetry/MyTelemetryInitializer.cs b/examples/EvaluationDataToApplicationInsights/Telemetry/MyTelemetryInitializer.cs

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ public ValueTask<TargetingContext> GetContextAsync()`
`29`	`29`	`return new ValueTask<TargetingContext>((TargetingContext)value);`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ //`
	`33`	`+ // Grab username from cookie`
`32`	`34`	`string username = httpContext.Request.Cookies["username"];`
`33`	`35`
`34`	`36`	`var groups = new List<string>();`