Blazor - rendering metrics and tracing #61609
+1,271
−444
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| } | ||
|
Comment on lines
+35
to
+110
There was a problem hiding this comment. This should go on the Server assembly. There was a problem hiding this comment. If we move it to different class/instance, we would not be able to use There was a problem hiding this comment. Isn't the CircuitId on a parent activity? (like start circuit or something like that) All the To put it in a different way, this method/class should not be responsible for resolving the parent activity to link to. That should be provided somehow. We might need public API for that. We don't want to keep adding to this list when/if we add new render modes. For example, I imagine WebView migth also want to track its own parent activity and it would require us to add it here. |
||
|
|
||
| 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); | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+112
to
+177
There was a problem hiding this comment. This probably needs to go into a different class |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Layering wise this shouldn't go here.
Microsoft.AspNetCore.Componentsshoudn't have a dependency onMicrosoft.AspNetCore.HostingThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please be more specific, what do you want to see instead ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you trying to get the activity of the current request here? There is a feature in the features collection for doing that: https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.http.features.ihttpactivityfeature.activity?view=aspnetcore-9.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can I get that from DI without passing HttpContext thru all SignalR layers ? Or from some TLS ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It comes from HttpContext. It's in the features collection.