Add test for the order of activity and metrics with HTTP requests (#56592)

Author: JamesNK

src/Hosting/Hosting/src/Internal/HostingApplicationDiagnostics.cs

@@ -208,7 +208,10 @@ public void RequestEnd(HttpContext httpContext, Exception? exception, HostingApp
         }
 
         var activity = context.Activity;
-        // Always stop activity if it was started
+        // Always stop activity if it was started.
+        // The HTTP activity must be stopped after the HTTP request duration metric is recorded.
+        // This order means the activity is ongoing while the metric is recorded and libraries like OTEL
+        // can capture the activity as a metric exemplar.
         if (activity is not null)
         {
             StopActivity(httpContext, activity, context.HasDiagnosticListener);

src/Hosting/Hosting/test/HostingApplicationDiagnosticsTests.cs

@@ -156,17 +156,63 @@ public void EventCountersEnabled()
     }
 
     [Fact]
-    public void MetricsEnabled()
+    public void Metrics_RequestDuration_RecordedWithHttpActivity()
     {
         // Arrange
-        var hostingEventSource = new HostingEventSource(Guid.NewGuid().ToString());
+        Activity measurementActivity = null;
+        var measureCount = 0;
+
+        // Listen to hosting activity source.
+        var testSource = new ActivitySource(Path.GetRandomFileName());
+        using var activityListener = new ActivityListener
+        {
+            ShouldListenTo = activitySource => ReferenceEquals(activitySource, testSource),
+            Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllData
+        };
+        ActivitySource.AddActivityListener(activityListener);
+
+        // Listen to http.server.request.duration.
+        var testMeterFactory = new TestMeterFactory();
+        var meterListener = new MeterListener();
+        meterListener.InstrumentPublished = (i, l) =>
+        {
+            if (i.Meter.Scope == testMeterFactory && i.Meter.Name == HostingMetrics.MeterName && i.Name == "http.server.request.duration")
+            {
+                l.EnableMeasurementEvents(i);
+            }
+        };
+        meterListener.SetMeasurementEventCallback<double>((i, m, t, s) =>
+        {
+            if (Interlocked.Increment(ref measureCount) > 1)
+            {
+                throw new Exception("Unexpected measurement count.");
+            }
+
+            measurementActivity = Activity.Current;
+        });
+        meterListener.Start();
+
+        // Act
+        var hostingApplication = CreateApplication(out var features, activitySource: testSource, meterFactory: testMeterFactory);
+        var context = hostingApplication.CreateContext(features);
+        hostingApplication.DisposeContext(context, null);
 
+        // Assert
+        Assert.Equal(1, measureCount);
+        Assert.NotNull(measurementActivity);
+        Assert.Equal(HostingApplicationDiagnostics.ActivityName, measurementActivity.OperationName);
+    }
+
+    [Fact]
+    public void MetricsEnabled()
+    {
+        // Arrange
         var testMeterFactory = new TestMeterFactory();
         using var activeRequestsCollector = new MetricCollector<long>(testMeterFactory, HostingMetrics.MeterName, "http.server.active_requests");
         using var requestDurationCollector = new MetricCollector<double>(testMeterFactory, HostingMetrics.MeterName, "http.server.request.duration");
 
         // Act
-        var hostingApplication = CreateApplication(out var features, eventSource: hostingEventSource, meterFactory: testMeterFactory);
+        var hostingApplication = CreateApplication(out var features, meterFactory: testMeterFactory);
         var context = hostingApplication.CreateContext(features);
 
         // Assert