[blazor] Diagnostic traces - OTEL names review (dotnet#62751)

pavelsavara · web-flow · commit bc106c911ad3 · 2025-07-17T16:53:47.000+02:00
diff --git a/src/Components/Components/src/ComponentsActivitySource.cs b/src/Components/Components/src/ComponentsActivitySource.cs
@@ -12,7 +12,7 @@ namespace Microsoft.AspNetCore.Components;
 internal class ComponentsActivitySource
 {
     internal const string Name = "Microsoft.AspNetCore.Components";
-    internal const string OnRouteName = $"{Name}.RouteChange";
+    internal const string OnRouteName = $"{Name}.Navigate";
     internal const string OnEventName = $"{Name}.HandleEvent";
 
     private static ActivitySource ActivitySource { get; } = new ActivitySource(Name);
@@ -23,7 +23,7 @@ public void Init(ComponentsActivityLinkStore store)
         _componentsActivityLinkStore = store;
     }
 
-    public ComponentsActivityHandle StartRouteActivity(string componentType, string route)
+    public ComponentsActivityHandle StartNavigateActivity(string componentType, string route)
     {
         var activity = ActivitySource.CreateActivity(OnRouteName, ActivityKind.Internal, parentId: null, null, null);
         if (activity is not null)
@@ -54,12 +54,12 @@ public ComponentsActivityHandle StartRouteActivity(string componentType, string
         return default;
     }
 
-    public void StopRouteActivity(ComponentsActivityHandle activityHandle, Exception? ex)
+    public void StopNavigateActivity(ComponentsActivityHandle activityHandle, Exception? ex)
     {
         StopComponentActivity(ComponentsActivityLinkStore.Route, activityHandle, ex);
     }
 
-    public static ComponentsActivityHandle StartEventActivity(string? componentType, string? methodName, string? attributeName)
+    public static ComponentsActivityHandle StartHandleEventActivity(string? componentType, string? methodName, string? attributeName)
     {
         var activity = ActivitySource.CreateActivity(OnEventName, ActivityKind.Internal, parentId: null, null, null);
 
@@ -91,21 +91,21 @@ public static ComponentsActivityHandle StartEventActivity(string? componentType,
         return default;
     }
 
-    public void StopEventActivity(ComponentsActivityHandle activityHandle, Exception? ex)
+    public void StopHandleEventActivity(ComponentsActivityHandle activityHandle, Exception? ex)
     {
         StopComponentActivity(ComponentsActivityLinkStore.Event, activityHandle, ex);
     }
 
-    public async Task CaptureEventStopAsync(Task task, ComponentsActivityHandle activityHandle)
+    public async Task CaptureHandleEventStopAsync(Task task, ComponentsActivityHandle activityHandle)
     {
         try
         {
             await task;
-            StopEventActivity(activityHandle, null);
+            StopHandleEventActivity(activityHandle, null);
         }
         catch (Exception ex)
         {
-            StopEventActivity(activityHandle, ex);
+            StopHandleEventActivity(activityHandle, ex);
         }
     }
 
diff --git a/src/Components/Components/src/RenderTree/Renderer.cs b/src/Components/Components/src/RenderTree/Renderer.cs
@@ -461,7 +461,7 @@ public virtual Task DispatchEventAsync(ulong eventHandlerId, EventFieldInfo? fie
         {
             receiverName ??= (callback.Receiver?.GetType() ?? callback.Delegate.Target?.GetType())?.FullName;
             methodName ??= callback.Delegate.Method?.Name;
-            activityHandle = ComponentsActivitySource.StartEventActivity(receiverName, methodName, attributeName);
+            activityHandle = ComponentsActivitySource.StartHandleEventActivity(receiverName, methodName, attributeName);
         }
 
         var eventStartTimestamp = ComponentMetrics != null && ComponentMetrics.IsEventEnabled ? Stopwatch.GetTimestamp() : 0;
@@ -518,7 +518,7 @@ public virtual Task DispatchEventAsync(ulong eventHandlerId, EventFieldInfo? fie
             // stop activity/trace
             if (ComponentActivitySource != null && activityHandle.Activity != null)
             {
-                _ = ComponentActivitySource.CaptureEventStopAsync(task, activityHandle);
+                _ = ComponentActivitySource.CaptureHandleEventStopAsync(task, activityHandle);
             }
         }
         catch (Exception e)
@@ -532,7 +532,7 @@ public virtual Task DispatchEventAsync(ulong eventHandlerId, EventFieldInfo? fie
 
             if (ComponentActivitySource != null && activityHandle.Activity != null)
             {
-                ComponentActivitySource.StopEventActivity(activityHandle, e);
+                ComponentActivitySource.StopHandleEventActivity(activityHandle, e);
             }
 
             HandleExceptionViaErrorBoundary(e, receiverComponentState);
diff --git a/src/Components/Components/src/Routing/Router.cs b/src/Components/Components/src/Routing/Router.cs
@@ -253,7 +253,7 @@ internal virtual void Refresh(bool isNavigationIntercepted)
             endpointRouteData = RouteTable.ProcessParameters(endpointRouteData);
             _renderHandle.Render(Found(endpointRouteData));
 
-            _renderHandle.ComponentActivitySource?.StopRouteActivity(activityHandle, null);
+            _renderHandle.ComponentActivitySource?.StopNavigateActivity(activityHandle, null);
             return;
         }
 
@@ -308,15 +308,15 @@ internal virtual void Refresh(bool isNavigationIntercepted)
                 NavigationManager.NavigateTo(_locationAbsolute, forceLoad: true);
             }
         }
-        _renderHandle.ComponentActivitySource?.StopRouteActivity(activityHandle, null);
+        _renderHandle.ComponentActivitySource?.StopNavigateActivity(activityHandle, null);
     }
 
     private ComponentsActivityHandle RecordDiagnostics(string componentType, string template)
     {
         ComponentsActivityHandle activityHandle = default;
         if (_renderHandle.ComponentActivitySource != null)
         {
-            activityHandle = _renderHandle.ComponentActivitySource.StartRouteActivity(componentType, template);
+            activityHandle = _renderHandle.ComponentActivitySource.StartNavigateActivity(componentType, template);
         }
 
         if (_renderHandle.ComponentMetrics != null && _renderHandle.ComponentMetrics.IsNavigationEnabled)
diff --git a/src/Components/Components/test/ComponentsActivitySourceTest.cs b/src/Components/Components/test/ComponentsActivitySourceTest.cs
@@ -50,7 +50,7 @@ public void StartRouteActivity_CreatesAndStartsActivity()
         linkstore.SetActivityContext(ComponentsActivityLinkStore.Circuit, new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded), new KeyValuePair<string, object>("aspnetcore.components.circuit.id", "test-circuit-id"));
 
         // Act
-        var activityHandle = componentsActivitySource.StartRouteActivity(componentType, route);
+        var activityHandle = componentsActivitySource.StartNavigateActivity(componentType, route);
         var activity = activityHandle.Activity;
 
         // Assert
@@ -63,7 +63,7 @@ public void StartRouteActivity_CreatesAndStartsActivity()
         Assert.Equal(route, activity.GetTagItem("aspnetcore.components.route"));
         Assert.False(activity.IsStopped);
 
-        componentsActivitySource.StopRouteActivity(activityHandle, null);
+        componentsActivitySource.StopNavigateActivity(activityHandle, null);
         Assert.True(activity.IsStopped);
         Assert.Equal("test-circuit-id", activity.GetTagItem("aspnetcore.components.circuit.id"));
         Assert.Single(activity.Links);
@@ -83,10 +83,10 @@ public void StartEventActivity_CreatesAndStartsActivity()
 
         // First set up a circuit and route context
         linkstore.SetActivityContext(ComponentsActivityLinkStore.Circuit, default, new KeyValuePair<string, object>("aspnetcore.components.circuit.id", "test-circuit-id"));
-        componentsActivitySource.StartRouteActivity("ParentComponent", "/parent");
+        componentsActivitySource.StartNavigateActivity("ParentComponent", "/parent");
 
         // Act
-        var activityHandle = ComponentsActivitySource.StartEventActivity(componentType, methodName, attributeName);
+        var activityHandle = ComponentsActivitySource.StartHandleEventActivity(componentType, methodName, attributeName);
         var activity = activityHandle.Activity;
 
         // Assert
@@ -100,7 +100,7 @@ public void StartEventActivity_CreatesAndStartsActivity()
         Assert.Equal(attributeName, activity.GetTagItem("aspnetcore.components.attribute.name"));
         Assert.False(activity.IsStopped);
 
-        componentsActivitySource.StopRouteActivity(activityHandle, null);
+        componentsActivitySource.StopNavigateActivity(activityHandle, null);
         Assert.True(activity.IsStopped);
         Assert.Equal("test-circuit-id", activity.GetTagItem("aspnetcore.components.circuit.id"));
         Assert.Empty(activity.Links);
@@ -113,12 +113,12 @@ public void FailEventActivity_SetsErrorStatusAndStopsActivity()
         var componentsActivitySource = new ComponentsActivitySource();
         var linkstore = new ComponentsActivityLinkStore(null);
         componentsActivitySource.Init(linkstore);
-        var activityHandle = ComponentsActivitySource.StartEventActivity("TestComponent", "OnClick", "onclick");
+        var activityHandle = ComponentsActivitySource.StartHandleEventActivity("TestComponent", "OnClick", "onclick");
         var activity = activityHandle.Activity;
         var exception = new InvalidOperationException("Test exception");
 
         // Act
-        componentsActivitySource.StopEventActivity(activityHandle, exception);
+        componentsActivitySource.StopHandleEventActivity(activityHandle, exception);
 
         // Assert
         Assert.True(activity!.IsStopped);
@@ -133,12 +133,12 @@ public async Task CaptureEventStopAsync_StopsActivityOnSuccessfulTask()
         var componentsActivitySource = new ComponentsActivitySource();
         var linkstore = new ComponentsActivityLinkStore(null);
         componentsActivitySource.Init(linkstore);
-        var activityHandle = ComponentsActivitySource.StartEventActivity("TestComponent", "OnClick", "onclick");
+        var activityHandle = ComponentsActivitySource.StartHandleEventActivity("TestComponent", "OnClick", "onclick");
         var activity = activityHandle.Activity;
         var task = Task.CompletedTask;
 
         // Act
-        await componentsActivitySource.CaptureEventStopAsync(task, activityHandle);
+        await componentsActivitySource.CaptureHandleEventStopAsync(task, activityHandle);
 
         // Assert
         Assert.True(activity!.IsStopped);
@@ -152,13 +152,13 @@ public async Task CaptureEventStopAsync_FailsActivityOnException()
         var componentsActivitySource = new ComponentsActivitySource();
         var linkstore = new ComponentsActivityLinkStore(null);
         componentsActivitySource.Init(linkstore);
-        var activityHandle = ComponentsActivitySource.StartEventActivity("TestComponent", "OnClick", "onclick");
+        var activityHandle = ComponentsActivitySource.StartHandleEventActivity("TestComponent", "OnClick", "onclick");
         var activity = activityHandle.Activity;
         var exception = new InvalidOperationException("Test exception");
         var task = Task.FromException(exception);
 
         // Act
-        await componentsActivitySource.CaptureEventStopAsync(task, activityHandle);
+        await componentsActivitySource.CaptureHandleEventStopAsync(task, activityHandle);
 
         // Assert
         Assert.True(activity!.IsStopped);
@@ -175,7 +175,7 @@ public void StartRouteActivity_HandlesNullValues()
         componentsActivitySource.Init(linkstore);
 
         // Act
-        var activityHandle = componentsActivitySource.StartRouteActivity(null, null);
+        var activityHandle = componentsActivitySource.StartNavigateActivity(null, null);
         var activity = activityHandle.Activity;
 
         // Assert
@@ -192,7 +192,7 @@ public void StartEventActivity_HandlesNullValues()
         componentsActivitySource.Init(linkstore);
 
         // Act
-        var activityHandle = ComponentsActivitySource.StartEventActivity(null, null, null);
+        var activityHandle = ComponentsActivitySource.StartHandleEventActivity(null, null, null);
         var activity = activityHandle.Activity;
 
         // Assert
diff --git a/src/Components/Server/src/Circuits/CircuitActivitySource.cs b/src/Components/Server/src/Circuits/CircuitActivitySource.cs
@@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Components.Server.Circuits;
 internal class CircuitActivitySource
 {
     internal const string Name = "Microsoft.AspNetCore.Components.Server.Circuits";
-    internal const string OnCircuitName = $"{Name}.CircuitStart";
+    internal const string OnCircuitName = $"{Name}.StartCircuit";
 
     private ComponentsActivityLinkStore? _activityLinkStore;
 
@@ -42,20 +42,22 @@ public CircuitActivityHandle StartCircuitActivity(string circuitId, ActivityCont
                 }
                 if (httpActivityContext != default)
                 {
-                    // store the http link
-                    _activityLinkStore.SetActivityContext(ComponentsActivityLinkStore.Http, httpActivityContext, null);
+                    // add the http link
+                    activity.AddLink(new ActivityLink(httpActivityContext));
                 }
                 if (signalRActivity != null && signalRActivity.Source.Name == "Microsoft.AspNetCore.SignalR.Server")
                 {
-                    // store the SignalR link
-                    _activityLinkStore.SetActivityContext(ComponentsActivityLinkStore.SignalR, signalRActivity.Context, null);
+                    // add the SignalR link
+                    activity.AddLink(new ActivityLink(signalRActivity.Context));
                 }
             }
             return new CircuitActivityHandle { Previous = signalRActivity, Activity = activity };
         }
         return default;
     }
 
+    // We call this at the end of circuit creation, rather than at the end of the circuit lifecycle
+    // because long-lived traces are difficult to work with in the telemetry UIs
     public void StopCircuitActivity(CircuitActivityHandle activityHandle, Exception? ex)
     {
         var activity = activityHandle.Activity;
diff --git a/src/Components/Server/test/Circuits/CircuitActivitySourceTest.cs b/src/Components/Server/test/Circuits/CircuitActivitySourceTest.cs
@@ -54,12 +54,11 @@ public void StartCircuitActivity_CreatesAndStartsActivity()
         Assert.Equal(ActivityKind.Internal, activity.Kind);
         Assert.True(activity.IsAllDataRequested);
         Assert.Equal(circuitId, activity.GetTagItem("aspnetcore.components.circuit.id"));
-        Assert.Empty(activity.Links);
+        Assert.Contains(activity.Links, link => link.Context == httpContext);
         Assert.False(activity.IsStopped);
 
         circuitActivitySource.StopCircuitActivity(activityHandle, null);
         Assert.True(activity.IsStopped);
-        Assert.Contains(activity.Links, link => link.Context == httpContext);
     }
 
     [Fact]

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace Microsoft.AspNetCore.Components;`
`12`	`12`	`internal class ComponentsActivitySource`
`13`	`13`	`{`
`14`	`14`	`internal const string Name = "Microsoft.AspNetCore.Components";`
`15`		`- internal const string OnRouteName = $"{Name}.RouteChange";`
	`15`	`+ internal const string OnRouteName = $"{Name}.Navigate";`
`16`	`16`	`internal const string OnEventName = $"{Name}.HandleEvent";`
`17`	`17`
`18`	`18`	`private static ActivitySource ActivitySource { get; } = new ActivitySource(Name);`
`@@ -23,7 +23,7 @@ public void Init(ComponentsActivityLinkStore store)`
`23`	`23`	`_componentsActivityLinkStore = store;`
`24`	`24`	`}`
`25`	`25`
`26`		`- public ComponentsActivityHandle StartRouteActivity(string componentType, string route)`
	`26`	`+ public ComponentsActivityHandle StartNavigateActivity(string componentType, string route)`
`27`	`27`	`{`
`28`	`28`	`var activity = ActivitySource.CreateActivity(OnRouteName, ActivityKind.Internal, parentId: null, null, null);`
`29`	`29`	`if (activity is not null)`
`@@ -54,12 +54,12 @@ public ComponentsActivityHandle StartRouteActivity(string componentType, string`
`54`	`54`	`return default;`
`55`	`55`	`}`
`56`	`56`
`57`		`- public void StopRouteActivity(ComponentsActivityHandle activityHandle, Exception? ex)`
	`57`	`+ public void StopNavigateActivity(ComponentsActivityHandle activityHandle, Exception? ex)`
`58`	`58`	`{`
`59`	`59`	`StopComponentActivity(ComponentsActivityLinkStore.Route, activityHandle, ex);`
`60`	`60`	`}`
`61`	`61`
`62`		`- public static ComponentsActivityHandle StartEventActivity(string? componentType, string? methodName, string? attributeName)`
	`62`	`+ public static ComponentsActivityHandle StartHandleEventActivity(string? componentType, string? methodName, string? attributeName)`
`63`	`63`	`{`
`64`	`64`	`var activity = ActivitySource.CreateActivity(OnEventName, ActivityKind.Internal, parentId: null, null, null);`
`65`	`65`
`@@ -91,21 +91,21 @@ public static ComponentsActivityHandle StartEventActivity(string? componentType,`
`91`	`91`	`return default;`
`92`	`92`	`}`
`93`	`93`
`94`		`- public void StopEventActivity(ComponentsActivityHandle activityHandle, Exception? ex)`
	`94`	`+ public void StopHandleEventActivity(ComponentsActivityHandle activityHandle, Exception? ex)`
`95`	`95`	`{`
`96`	`96`	`StopComponentActivity(ComponentsActivityLinkStore.Event, activityHandle, ex);`
`97`	`97`	`}`
`98`	`98`
`99`		`- public async Task CaptureEventStopAsync(Task task, ComponentsActivityHandle activityHandle)`
	`99`	`+ public async Task CaptureHandleEventStopAsync(Task task, ComponentsActivityHandle activityHandle)`
`100`	`100`	`{`
`101`	`101`	`try`
`102`	`102`	`{`
`103`	`103`	`await task;`
`104`		`- StopEventActivity(activityHandle, null);`
	`104`	`+ StopHandleEventActivity(activityHandle, null);`
`105`	`105`	`}`
`106`	`106`	`catch (Exception ex)`
`107`	`107`	`{`
`108`		`- StopEventActivity(activityHandle, ex);`
	`108`	`+ StopHandleEventActivity(activityHandle, ex);`
`109`	`109`	`}`
`110`	`110`	`}`
`111`	`111`
Original file line number	Diff line number	Diff line change
`@@ -461,7 +461,7 @@ public virtual Task DispatchEventAsync(ulong eventHandlerId, EventFieldInfo? fie`
`461`	`461`	`{`
`462`	`462`	`receiverName ??= (callback.Receiver?.GetType() ?? callback.Delegate.Target?.GetType())?.FullName;`
`463`	`463`	`methodName ??= callback.Delegate.Method?.Name;`
`464`		`- activityHandle = ComponentsActivitySource.StartEventActivity(receiverName, methodName, attributeName);`
	`464`	`+ activityHandle = ComponentsActivitySource.StartHandleEventActivity(receiverName, methodName, attributeName);`
`465`	`465`	`}`
`466`	`466`
`467`	`467`	`var eventStartTimestamp = ComponentMetrics != null && ComponentMetrics.IsEventEnabled ? Stopwatch.GetTimestamp() : 0;`
`@@ -518,7 +518,7 @@ public virtual Task DispatchEventAsync(ulong eventHandlerId, EventFieldInfo? fie`
`518`	`518`	`// stop activity/trace`
`519`	`519`	`if (ComponentActivitySource != null && activityHandle.Activity != null)`
`520`	`520`	`{`
`521`		`- _ = ComponentActivitySource.CaptureEventStopAsync(task, activityHandle);`
	`521`	`+ _ = ComponentActivitySource.CaptureHandleEventStopAsync(task, activityHandle);`
`522`	`522`	`}`
`523`	`523`	`}`
`524`	`524`	`catch (Exception e)`
`@@ -532,7 +532,7 @@ public virtual Task DispatchEventAsync(ulong eventHandlerId, EventFieldInfo? fie`
`532`	`532`
`533`	`533`	`if (ComponentActivitySource != null && activityHandle.Activity != null)`
`534`	`534`	`{`
`535`		`- ComponentActivitySource.StopEventActivity(activityHandle, e);`
	`535`	`+ ComponentActivitySource.StopHandleEventActivity(activityHandle, e);`
`536`	`536`	`}`
`537`	`537`
`538`	`538`	`HandleExceptionViaErrorBoundary(e, receiverComponentState);`
Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@ internal virtual void Refresh(bool isNavigationIntercepted)`
`253`	`253`	`endpointRouteData = RouteTable.ProcessParameters(endpointRouteData);`
`254`	`254`	`_renderHandle.Render(Found(endpointRouteData));`
`255`	`255`
`256`		`- _renderHandle.ComponentActivitySource?.StopRouteActivity(activityHandle, null);`
	`256`	`+ _renderHandle.ComponentActivitySource?.StopNavigateActivity(activityHandle, null);`
`257`	`257`	`return;`
`258`	`258`	`}`
`259`	`259`
`@@ -308,15 +308,15 @@ internal virtual void Refresh(bool isNavigationIntercepted)`
`308`	`308`	`NavigationManager.NavigateTo(_locationAbsolute, forceLoad: true);`
`309`	`309`	`}`
`310`	`310`	`}`
`311`		`- _renderHandle.ComponentActivitySource?.StopRouteActivity(activityHandle, null);`
	`311`	`+ _renderHandle.ComponentActivitySource?.StopNavigateActivity(activityHandle, null);`
`312`	`312`	`}`
`313`	`313`
`314`	`314`	`private ComponentsActivityHandle RecordDiagnostics(string componentType, string template)`
`315`	`315`	`{`
`316`	`316`	`ComponentsActivityHandle activityHandle = default;`
`317`	`317`	`if (_renderHandle.ComponentActivitySource != null)`
`318`	`318`	`{`
`319`		`- activityHandle = _renderHandle.ComponentActivitySource.StartRouteActivity(componentType, template);`
	`319`	`+ activityHandle = _renderHandle.ComponentActivitySource.StartNavigateActivity(componentType, template);`
`320`	`320`	`}`
`321`	`321`
`322`	`322`	`if (_renderHandle.ComponentMetrics != null && _renderHandle.ComponentMetrics.IsNavigationEnabled)`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Components.Server.Circuits;`
`9`	`9`	`internal class CircuitActivitySource`
`10`	`10`	`{`
`11`	`11`	`internal const string Name = "Microsoft.AspNetCore.Components.Server.Circuits";`
`12`		`- internal const string OnCircuitName = $"{Name}.CircuitStart";`
	`12`	`+ internal const string OnCircuitName = $"{Name}.StartCircuit";`
`13`	`13`
`14`	`14`	`private ComponentsActivityLinkStore? _activityLinkStore;`
`15`	`15`
`@@ -42,20 +42,22 @@ public CircuitActivityHandle StartCircuitActivity(string circuitId, ActivityCont`
`42`	`42`	`}`
`43`	`43`	`if (httpActivityContext != default)`
`44`	`44`	`{`
`45`		`- // store the http link`
`46`		`- _activityLinkStore.SetActivityContext(ComponentsActivityLinkStore.Http, httpActivityContext, null);`
	`45`	`+ // add the http link`
	`46`	`+ activity.AddLink(new ActivityLink(httpActivityContext));`
`47`	`47`	`}`
`48`	`48`	`if (signalRActivity != null && signalRActivity.Source.Name == "Microsoft.AspNetCore.SignalR.Server")`
`49`	`49`	`{`
`50`		`- // store the SignalR link`
`51`		`- _activityLinkStore.SetActivityContext(ComponentsActivityLinkStore.SignalR, signalRActivity.Context, null);`
	`50`	`+ // add the SignalR link`
	`51`	`+ activity.AddLink(new ActivityLink(signalRActivity.Context));`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`	`return new CircuitActivityHandle { Previous = signalRActivity, Activity = activity };`
`55`	`55`	`}`
`56`	`56`	`return default;`
`57`	`57`	`}`
`58`	`58`
	`59`	`+ // We call this at the end of circuit creation, rather than at the end of the circuit lifecycle`
	`60`	`+ // because long-lived traces are difficult to work with in the telemetry UIs`
`59`	`61`	`public void StopCircuitActivity(CircuitActivityHandle activityHandle, Exception? ex)`
`60`	`62`	`{`
`61`	`63`	`var activity = activityHandle.Activity;`