[Instrumentation.AspNetCore] Fix http.route for HTTP server spans #3338
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| // 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
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. |
||
| { | ||
| if (routePattern.PathSegments.Count == 0) | ||
| { | ||
| // RazorPage default route | ||
| if (routePattern.Defaults.ContainsKey("page")) | ||
| { | ||
| return routePattern.Defaults["page"]?.ToString()?.Trim('/') | ||
martincostello marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ?? 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": | ||
| routePattern.RequiredValues.TryGetValue(parameterPart.Name, out var parameterValue); | ||
| if (parameterValue != null) | ||
martincostello marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| { | ||
| sb.Append(parameterValue); | ||
| sb.Append('/'); | ||
|
Contributor
There was a problem hiding this comment. Why not look for separator part for adding separator? |
||
| 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. |
||
| sb.Append('}'); | ||
| sb.Append('/'); | ||
| } | ||
|
|
||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Remove the trailing '/' | ||
| return sb.ToString(0, sb.Length - 1); | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
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.
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.
You need a very large suite of unit tests to ensure every possible route is correctly converted into a string.