Blazor - rendering metrics and tracing

src/Components/Components/src/ComponentsActivitySource.cs

@@ -0,0 +1,177 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics;
+
+namespace Microsoft.AspNetCore.Components;
+
+/// <summary>
+/// This is instance scoped per renderer
+/// </summary>
+internal class ComponentsActivitySource
+{
+    internal const string Name = "Microsoft.AspNetCore.Components";
+    internal const string OnCircuitName = $"{Name}.CircuitStart";
+    internal const string OnRouteName = $"{Name}.RouteChange";
+    internal const string OnEventName = $"{Name}.HandleEvent";
+
+    private ActivityContext _httpContext;
+    private ActivityContext _circuitContext;
+    private string? _circuitId;
+    private ActivityContext _routeContext;
+
+    private ActivitySource ActivitySource { get; } = new ActivitySource(Name);
+
+    public static ActivityContext CaptureHttpContext()
+    {
+        var parentActivity = Activity.Current;
+        if (parentActivity is not null && parentActivity.OperationName == "Microsoft.AspNetCore.Hosting.HttpRequestIn" && parentActivity.Recorded)
+        {
+            return parentActivity.Context;
+        }
+        return default;
+    }
+
+    public Activity? StartCircuitActivity(string circuitId, ActivityContext httpContext)
+    {
+        _circuitId = circuitId;
+
+        var activity = ActivitySource.CreateActivity(OnCircuitName, ActivityKind.Internal, parentId: null, null, null);
+        if (activity is not null)
+        {
+            if (activity.IsAllDataRequested)
+            {
+                if (_circuitId != null)
+                {
+                    activity.SetTag("aspnetcore.components.circuit.id", _circuitId);
+                }
+                if (httpContext != default)
+                {
+                    activity.AddLink(new ActivityLink(httpContext));
+                }
+            }
+            activity.DisplayName = $"Circuit {circuitId ?? ""}";
+            activity.Start();
+            _circuitContext = activity.Context;
+        }
+        return activity;
+    }
+
+    public void FailCircuitActivity(Activity? activity, Exception ex)
+    {
+        _circuitContext = default;
+        if (activity != null && !activity.IsStopped)
+        {
+            activity.SetTag("error.type", ex.GetType().FullName);
+            activity.SetStatus(ActivityStatusCode.Error);
+            activity.Stop();
+        }
+    }
+
+    public Activity? StartRouteActivity(string componentType, string route)
+    {
+        if (_httpContext == default)
+        {
+            _httpContext = CaptureHttpContext();
+        }
+
+        var activity = ActivitySource.CreateActivity(OnRouteName, ActivityKind.Internal, parentId: null, null, null);
+        if (activity is not null)
+        {
+            if (activity.IsAllDataRequested)
+            {
+                if (_circuitId != null)
+                {
+                    activity.SetTag("aspnetcore.components.circuit.id", _circuitId);
+                }
+                if (componentType != null)
+                {
+                    activity.SetTag("aspnetcore.components.type", componentType);
+                }
+                if (route != null)
+                {
+                    activity.SetTag("aspnetcore.components.route", route);
+                }
+                if (_httpContext != default)
+                {
+                    activity.AddLink(new ActivityLink(_httpContext));
+                }
+                if (_circuitContext != default)
+                {
+                    activity.AddLink(new ActivityLink(_circuitContext));
+                }
+            }
+
+            activity.DisplayName = $"Route {route ?? "[unknown path]"} -> {componentType ?? "[unknown component]"}";
+            activity.Start();
+            _routeContext = activity.Context;
+        }
+        return activity;
+    }
+
+    public Activity? StartEventActivity(string? componentType, string? methodName, string? attributeName)
+    {
+        var activity = ActivitySource.CreateActivity(OnEventName, ActivityKind.Internal, parentId: null, null, null);
+        if (activity is not null)
+        {
+            if (activity.IsAllDataRequested)
+            {
+                if (_circuitId != null)
+                {
+                    activity.SetTag("aspnetcore.components.circuit.id", _circuitId);
+                }
+                if (componentType != null)
+                {
+                    activity.SetTag("aspnetcore.components.type", componentType);
+                }
+                if (methodName != null)
+                {
+                    activity.SetTag("aspnetcore.components.method", methodName);
+                }
+                if (attributeName != null)
+                {
+                    activity.SetTag("aspnetcore.components.attribute.name", attributeName);
+                }
+                if (_httpContext != default)
+                {
+                    activity.AddLink(new ActivityLink(_httpContext));
+                }
+                if (_circuitContext != default)
+                {
+                    activity.AddLink(new ActivityLink(_circuitContext));
+                }
+                if (_routeContext != default)
+                {
+                    activity.AddLink(new ActivityLink(_routeContext));
+                }
+            }
+
+            activity.DisplayName = $"Event {attributeName ?? "[unknown attribute]"} -> {componentType ?? "[unknown component]"}.{methodName ?? "[unknown method]"}";
+            activity.Start();
+        }
+        return activity;
+    }
+
+    public static void FailEventActivity(Activity? activity, Exception ex)
+    {
+        if (activity != null && !activity.IsStopped)
+        {
+            activity.SetTag("error.type", ex.GetType().FullName);
+            activity.SetStatus(ActivityStatusCode.Error);
+            activity.Stop();
+        }
+    }
+
+    public static async Task CaptureEventStopAsync(Task task, Activity? activity)
+    {
+        try
+        {
+            await task;
+            activity?.Stop();
+        }
+        catch (Exception ex)
+        {
+            FailEventActivity(activity, ex);
+        }
+    }
+}

src/Components/Components/src/ComponentsMetrics.cs

@@ -0,0 +1,191 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics;
+using System.Diagnostics.Metrics;
+using Microsoft.AspNetCore.Components;
+using Microsoft.AspNetCore.Http;
+
+namespace Microsoft.AspNetCore.Components;
+
+internal sealed class ComponentsMetrics : IDisposable
+{
+    public const string MeterName = "Microsoft.AspNetCore.Components";
+    public const string LifecycleMeterName = "Microsoft.AspNetCore.Components.Lifecycle";
+    private readonly Meter _meter;
+    private readonly Meter _lifeCycleMeter;
+
+    private readonly Counter<long> _navigationCount;
+
+    private readonly Histogram<double> _eventDuration;
+    private readonly Histogram<double> _parametersDuration;
+    private readonly Histogram<double> _batchDuration;
+
+    public bool IsNavigationEnabled => _navigationCount.Enabled;
+
+    public bool IsEventEnabled => _eventDuration.Enabled;
+
+    public bool IsParametersEnabled => _parametersDuration.Enabled;
+
+    public bool IsBatchEnabled => _batchDuration.Enabled;
+
+    public ComponentsMetrics(IMeterFactory meterFactory)
+    {
+        Debug.Assert(meterFactory != null);
+
+        _meter = meterFactory.Create(MeterName);
+        _lifeCycleMeter = meterFactory.Create(LifecycleMeterName);
+
+        _navigationCount = _meter.CreateCounter<long>(
+            "aspnetcore.components.navigation",
+            unit: "{route}",
+            description: "Total number of route changes.");
+
+        _eventDuration = _meter.CreateHistogram(
+            "aspnetcore.components.event_handler",
+            unit: "s",
+            description: "Duration of processing browser event.  It includes business logic of the component but not affected child components.",
+            advice: new InstrumentAdvice<double> { HistogramBucketBoundaries = MetricsConstants.ShortSecondsBucketBoundaries });
+
+        _parametersDuration = _lifeCycleMeter.CreateHistogram(
+            "aspnetcore.components.update_parameters",
+            unit: "s",
+            description: "Duration of processing component parameters. It includes business logic of the component.",
+            advice: new InstrumentAdvice<double> { HistogramBucketBoundaries = MetricsConstants.BlazorRenderingSecondsBucketBoundaries });
+
+        _batchDuration = _lifeCycleMeter.CreateHistogram(
+            "aspnetcore.components.render_diff",
+            unit: "s",
+            description: "Duration of rendering component tree and producing HTML diff. It includes business logic of the changed components.",
+            advice: new InstrumentAdvice<double> { HistogramBucketBoundaries = MetricsConstants.BlazorRenderingSecondsBucketBoundaries });
+    }
+
+    public void Navigation(string componentType, string route)
+    {
+        var tags = new TagList
+        {
+            { "aspnetcore.components.type", componentType ?? "unknown" },
+            { "aspnetcore.components.route", route ?? "unknown" },
+        };
+
+        _navigationCount.Add(1, tags);
+    }
+
+    public async Task CaptureEventDuration(Task task, long startTimestamp, string? componentType, string? methodName, string? attributeName)
+    {
+        var tags = new TagList
+        {
+            { "aspnetcore.components.type", componentType ?? "unknown" },
+            { "aspnetcore.components.method", methodName ?? "unknown" },
+            { "aspnetcore.components.attribute.name", attributeName ?? "unknown" }
+        };
+
+        try
+        {
+            await task;
+        }
+        catch (Exception ex)
+        {
+            tags.Add("error.type", ex.GetType().FullName ?? "unknown");
+        }
+        var duration = Stopwatch.GetElapsedTime(startTimestamp);
+        _eventDuration.Record(duration.TotalSeconds, tags);
+    }
+
+    public void FailEventSync(Exception ex, long startTimestamp, string? componentType, string? methodName, string? attributeName)
+    {
+        var tags = new TagList
+        {
+            { "aspnetcore.components.type", componentType ?? "unknown" },
+            { "aspnetcore.components.method", methodName ?? "unknown" },
+            { "aspnetcore.components.attribute.name", attributeName ?? "unknown" },
+            { "error.type", ex.GetType().FullName ?? "unknown" }
+        };
+        var duration = Stopwatch.GetElapsedTime(startTimestamp);
+        _eventDuration.Record(duration.TotalSeconds, tags);
+    }
+
+    public async Task CaptureParametersDuration(Task task, long startTimestamp, string? componentType)
+    {
+        var tags = new TagList
+        {
+            { "aspnetcore.components.type", componentType ?? "unknown" },
+        };
+
+        try
+        {
+            await task;
+        }
+        catch(Exception ex)
+        {
+            tags.Add("error.type", ex.GetType().FullName ?? "unknown");
+        }
+        var duration = Stopwatch.GetElapsedTime(startTimestamp);
+        _parametersDuration.Record(duration.TotalSeconds, tags);
+    }
+
+    public void FailParametersSync(Exception ex, long startTimestamp, string? componentType)
+    {
+        var duration = Stopwatch.GetElapsedTime(startTimestamp);
+        var tags = new TagList
+        {
+            { "aspnetcore.components.type", componentType ?? "unknown" },
+            { "error.type", ex.GetType().FullName ?? "unknown" }
+        };
+        _parametersDuration.Record(duration.TotalSeconds, tags);
+    }
+
+    public async Task CaptureBatchDuration(Task task, long startTimestamp, int diffLength)
+    {
+        var tags = new TagList
+        {
+            { "aspnetcore.components.diff.length", BucketDiffLength(diffLength) }
+        };
+
+        try
+        {
+            await task;
+        }
+        catch (Exception ex)
+        {
+            tags.Add("error.type", ex.GetType().FullName ?? "unknown");
+        }
+        var duration = Stopwatch.GetElapsedTime(startTimestamp);
+        _batchDuration.Record(duration.TotalSeconds, tags);
+    }
+
+    public void FailBatchSync(Exception ex, long startTimestamp)
+    {
+        var duration = Stopwatch.GetElapsedTime(startTimestamp);
+        var tags = new TagList
+            {
+                { "aspnetcore.components.diff.length", 0 },
+                { "error.type", ex.GetType().FullName ?? "unknown" }
+            };
+        _batchDuration.Record(duration.TotalSeconds, tags);
+    }
+
+    private static int BucketDiffLength(int diffLength)
+    {
+        return diffLength switch
+        {
+            <= 1 => 1,
+            <= 2 => 2,
+            <= 5 => 5,
+            <= 10 => 10,
+            <= 20 => 20,
+            <= 50 => 50,
+            <= 100 => 100,
+            <= 500 => 500,
+            <= 1000 => 1000,
+            <= 10000 => 10000,
+            _ => 10001,
+        };
+    }
+
+    public void Dispose()
+    {
+        _meter.Dispose();
+        _lifeCycleMeter.Dispose();
+    }
+}

src/Components/Components/src/Microsoft.AspNetCore.Components.csproj

@@ -79,6 +79,7 @@
 
   <ItemGroup>
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Web" />
+    <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Server" />
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Blazor.Build.Tests" />
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Authorization.Tests" />
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Forms.Tests" />

src/Components/Components/src/PublicAPI.Unshipped.txt

@@ -1,7 +1,7 @@
 #nullable enable
-
 Microsoft.AspNetCore.Components.Routing.Router.NotFoundPage.get -> System.Type!
 Microsoft.AspNetCore.Components.Routing.Router.NotFoundPage.set -> void
+Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions
 Microsoft.AspNetCore.Components.NavigationManager.OnNotFound -> System.EventHandler<Microsoft.AspNetCore.Components.Routing.NotFoundEventArgs!>!
 Microsoft.AspNetCore.Components.NavigationManager.NotFound() -> void
 Microsoft.AspNetCore.Components.Routing.IHostEnvironmentNavigationManager.Initialize(string! baseUri, string! uri, System.Func<string!, System.Threading.Tasks.Task!>! onNavigateTo) -> void
@@ -14,5 +14,7 @@ Microsoft.AspNetCore.Components.SupplyParameterFromPersistentComponentStateAttri
 Microsoft.AspNetCore.Components.SupplyParameterFromPersistentComponentStateAttribute.SupplyParameterFromPersistentComponentStateAttribute() -> void
 Microsoft.Extensions.DependencyInjection.SupplyParameterFromPersistentComponentStateProviderServiceCollectionExtensions
 static Microsoft.AspNetCore.Components.Infrastructure.RegisterPersistentComponentStateServiceCollectionExtensions.AddPersistentServiceRegistration<TService>(Microsoft.Extensions.DependencyInjection.IServiceCollection! services, Microsoft.AspNetCore.Components.IComponentRenderMode! componentRenderMode) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions.AddComponentsMetrics(Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
+static Microsoft.AspNetCore.Components.Infrastructure.ComponentsMetricsServiceCollectionExtensions.AddComponentsTracing(Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 static Microsoft.Extensions.DependencyInjection.SupplyParameterFromPersistentComponentStateProviderServiceCollectionExtensions.AddSupplyValueFromPersistentComponentStateProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
 virtual Microsoft.AspNetCore.Components.RenderTree.Renderer.SignalRendererToFinishRendering() -> void