[Instrumentation.AspNetCore] Fix http.route for HTTP server spans #3338
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| #if !NETSTANDARD | ||
|
|
||
| using System.Diagnostics; | ||
| using System.Text; | ||
| using Microsoft.AspNetCore.Http; | ||
| using Microsoft.AspNetCore.Routing; | ||
| using Microsoft.AspNetCore.Routing.Patterns; | ||
| using OpenTelemetry.Trace; | ||
|
|
||
| namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation; | ||
|
|
||
| internal static class RouteAttributeHelper | ||
| { | ||
| public static void AddRouteAttribute(this TagList tags, RouteEndpoint endpoint, HttpRequest request) | ||
| { | ||
| var routePattern = GetRoutePattern(endpoint.RoutePattern, request.RouteValues); | ||
|
|
||
| if (!string.IsNullOrEmpty(routePattern)) | ||
| { | ||
| tags.Add(new KeyValuePair<string, object?>(SemanticConventions.AttributeHttpRoute, routePattern)); | ||
| } | ||
| } | ||
|
|
||
| public static void SetRouteAttributeTag(this Activity activity, RouteEndpoint endpoint, HttpRequest request) | ||
| { | ||
| var routePattern = GetRoutePattern(endpoint.RoutePattern, request.RouteValues); | ||
|
|
||
| if (!string.IsNullOrEmpty(routePattern)) | ||
| { | ||
| TelemetryHelper.RequestDataHelper.SetActivityDisplayName(activity, request.Method, routePattern); | ||
| activity.SetTag(SemanticConventions.AttributeHttpRoute, routePattern); | ||
| } | ||
| } | ||
|
|
||
| private static string GetRoutePattern(RoutePattern routePattern, RouteValueDictionary routeValues) | ||
|
Contributor
There was a problem hiding this comment. Unrelated, but I think an empty string route should resolve to
Contributor
Author
There was a problem hiding this comment. I'm wondering if it should be removed completely if it's empty (empty means no route found), since:
src: https://opentelemetry.io/docs/specs/semconv/registry/attributes/http/
Contributor
There was a problem hiding this comment. This always runs, right? Should it only run if the route needs to change? i.e. there are area/controller/action/page attributes and a value is present in the requests route values collection.
Contributor
Author
There was a problem hiding this comment. Correct. It would be a nice optimization. Also connected to #3338 (comment) (so it runs only if the framework provides the values). |
||
| { | ||
| if (routePattern.PathSegments.Count == 0) | ||
| { | ||
| // RazorPage default route | ||
| if (routePattern.Defaults.TryGetValue("page", out var pageValue)) | ||
| { | ||
| return pageValue?.ToString()?.Trim('/') | ||
| ?? string.Empty; | ||
| } | ||
|
|
||
| return string.Empty; | ||
| } | ||
|
|
||
| var sb = new StringBuilder(); | ||
|
|
||
| foreach (var segment in routePattern.PathSegments) | ||
| { | ||
| foreach (var part in segment.Parts) | ||
| { | ||
| if (part is RoutePatternLiteralPart literalPart) | ||
| { | ||
| sb.Append(literalPart.Content); | ||
| sb.Append('/'); | ||
| } | ||
| else if (part is RoutePatternParameterPart parameterPart) | ||
| { | ||
| switch (parameterPart.Name) | ||
| { | ||
| case "area": | ||
| case "controller": | ||
| case "action": | ||
| if (routePattern.RequiredValues.TryGetValue(parameterPart.Name, out var parameterValue) && parameterValue != null) | ||
| { | ||
| sb.Append(parameterValue); | ||
| sb.Append('/'); | ||
|
Contributor
There was a problem hiding this comment. Why not look for separator part for adding separator?
Contributor
Author
There was a problem hiding this comment. @JamesNK there are no separator parts although routePattern is According to the doc |
||
| break; | ||
| } | ||
|
|
||
| goto default; | ||
| default: | ||
| if (!parameterPart.IsOptional || | ||
| (parameterPart.IsOptional && routeValues.ContainsKey(parameterPart.Name))) | ||
| { | ||
| sb.Append('{'); | ||
| sb.Append(parameterPart.Name); | ||
|
Contributor
There was a problem hiding this comment. What happens if there are default values? Or it is catch all? Or has constraints? Or has optional path extension. There are also complex segments. Are those being handled correctly? See https://learn.microsoft.com/en-us/aspnet/core/fundamentals/routing?view=aspnetcore-9.0#complex-segments Maybe these scenarios are already handled correctly, but unit tests to verify are important.
Contributor
Author
There was a problem hiding this comment. Unfortunately the test infra is doing a loads of assumptions. In that case it needs to be rewritten so |
||
| sb.Append('}'); | ||
| sb.Append('/'); | ||
| } | ||
|
|
||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Remove the trailing '/' | ||
| return sb.ToString(0, sb.Length - 1); | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
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.
You need a very large suite of unit tests to ensure every possible route is correctly converted into a string.
Uh oh!
There was an error while loading. Please reload this page.
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.
I agree, that there are probably loads of assumptions (if a general case is working).