[Instrumentation.Owin] Update to semantic convention v1.27.0 (open-telemetry#2028)

Author: ysolomchenko

src/OpenTelemetry.Instrumentation.Owin/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+* Updated activity tags to use new
+  [semantic conventions](https://github.com/open-telemetry/semantic-conventions/tree/v1.27.0/docs/http/http-spans.md)
+  attribute schema.
+  ([#2028](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2028))
+
 * Updated OpenTelemetry core component version(s) to `1.9.0`.
   ([#1888](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1888))
 

src/OpenTelemetry.Instrumentation.Owin/Implementation/DiagnosticsMiddleware.cs

@@ -20,6 +20,8 @@ internal sealed class DiagnosticsMiddleware : OwinMiddleware
     private static readonly Func<IOwinRequest, string, IEnumerable<string>> OwinRequestHeaderValuesGetter
         = (request, name) => request.Headers.GetValues(name);
 
+    private static readonly RequestDataHelper RequestDataHelper = new(configureByHttpKnownMethodsEnvironmentalVariable: false);
+
     /// <summary>
     /// Initializes a new instance of the <see cref="DiagnosticsMiddleware"/> class.
     /// </summary>
@@ -84,39 +86,26 @@ private static void BeginRequest(IOwinContext owinContext)
         {
             var request = owinContext.Request;
 
-            /*
-             * Note: Display name is intentionally set to a low cardinality
-             * value because OWIN does not expose any kind of
-             * route/template. See:
-             * https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#name
-             */
-            activity.DisplayName = request.Method switch
-            {
-                "GET" => "HTTP GET",
-                "POST" => "HTTP POST",
-                "PUT" => "HTTP PUT",
-                "DELETE" => "HTTP DELETE",
-                _ => $"HTTP {request.Method}",
-            };
+            // Note: Display name is intentionally set to a low cardinality
+            // value because OWIN does not expose any kind of
+            // route/template. See:
+            // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#name
+            RequestDataHelper.SetActivityDisplayName(activity, request.Method);
 
             if (activity.IsAllDataRequested)
             {
-                if (request.Uri.Port == 80 || request.Uri.Port == 443)
-                {
-                    activity.SetTag(SemanticConventions.AttributeHttpHost, request.Uri.Host);
-                }
-                else
-                {
-                    activity.SetTag(SemanticConventions.AttributeHttpHost, request.Uri.Host + ":" + request.Uri.Port);
-                }
+                RequestDataHelper.SetHttpMethodTag(activity, request.Method);
+                activity.SetTag(SemanticConventions.AttributeServerAddress, request.Uri.Host);
+                activity.SetTag(SemanticConventions.AttributeServerPort, request.Uri.Port);
+                activity.SetTag(SemanticConventions.AttributeNetworkProtocolVersion, request.Protocol);
 
-                activity.SetTag(SemanticConventions.AttributeHttpMethod, request.Method);
-                activity.SetTag(SemanticConventions.AttributeHttpTarget, request.Uri.AbsolutePath);
-                activity.SetTag(SemanticConventions.AttributeHttpUrl, GetUriTagValueFromRequestUri(request.Uri, OwinInstrumentationActivitySource.Options.DisableUrlQueryRedaction));
+                activity.SetTag(SemanticConventions.AttributeUrlPath, request.Uri.AbsolutePath);
+                activity.SetTag(SemanticConventions.AttributeUrlQuery, request.Query);
+                activity.SetTag(SemanticConventions.AttributeUrlScheme, owinContext.Request.Scheme);
 
                 if (request.Headers.TryGetValue("User-Agent", out string[] userAgent) && userAgent.Length > 0)
                 {
-                    activity.SetTag(SemanticConventions.AttributeHttpUserAgent, userAgent[0]);
+                    activity.SetTag(SemanticConventions.AttributeUserAgentOriginal, userAgent[0]);
                 }
 
                 try
@@ -163,7 +152,7 @@ private static void RequestEnd(IOwinContext owinContext, Exception? exception, l
                 {
                     activity.SetStatus(Status.Error);
 
-                    if (OwinInstrumentationActivitySource.Options != null && OwinInstrumentationActivitySource.Options.RecordException)
+                    if (OwinInstrumentationActivitySource.Options?.RecordException == true)
                     {
                         activity.RecordException(exception);
                     }
@@ -173,7 +162,7 @@ private static void RequestEnd(IOwinContext owinContext, Exception? exception, l
                     activity.SetStatus(SpanHelper.ResolveActivityStatusForHttpStatusCode(activity.Kind, response.StatusCode));
                 }
 
-                activity.SetTag(SemanticConventions.AttributeHttpStatusCode, response.StatusCode);
+                activity.SetTag(SemanticConventions.AttributeHttpResponseStatusCode, response.StatusCode);
 
                 try
                 {

src/OpenTelemetry.Instrumentation.Owin/OpenTelemetry.Instrumentation.Owin.csproj

@@ -20,6 +20,7 @@
     <Compile Include="$(RepoRoot)\src\Shared\Guard.cs" Link="Includes\Guard.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Options\*.cs" Link="Includes\Options\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\RedactionHelper.cs" Link="Includes\RedactionHelper.cs" />
+    <Compile Include="$(RepoRoot)\src\Shared\RequestDataHelper.cs" Link="Includes\RequestDataHelper.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\SemanticConventions.cs" Link="Includes\SemanticConventions.cs"/>
     <Compile Include="$(RepoRoot)\src\Shared\SpanHelper.cs" Link="Includes\SpanHelper.cs" />
   </ItemGroup>

src/OpenTelemetry.Instrumentation.Owin/README.md

@@ -59,6 +59,25 @@ OpenTelemetry instrumentation which listens to the OWIN diagnostic events.
         .Build();
 ```
 
+Following list of attributes are added by default on activity. See
+[http-spans](https://github.com/open-telemetry/semantic-conventions/tree/v1.27.0/docs/http/http-spans.md)
+for more details about each individual attribute:
+
+* `http.request.method`
+* `http.request.method_original`
+* `http.response.status_code`
+* `network.protocol.version`
+* `user_agent.original`
+* `server.address`
+* `server.port`
+* `url.path`
+* `url.query` - By default, the values in the query component are replaced with
+  the text `Redacted`. For example, `?key1=value1&key2=value2` becomes
+  `?key1=Redacted&key2=Redacted`. You can disable this redaction by setting the
+  environment variable
+  `OTEL_DOTNET_EXPERIMENTAL_OWIN_DISABLE_URL_QUERY_REDACTION` to `true`.
+* `url.scheme`
+
 #### Configure OpenTelemetry MeterProvider
 
 Call the `AddOwinInstrumentation` `MeterProviderBuilder` extension to register

test/OpenTelemetry.Instrumentation.Owin.Tests/DiagnosticsMiddlewareTests.cs

@@ -195,12 +195,12 @@ Owin has finished to inspect the activity status. */
                 Activity activity = stoppedActivities[0];
                 Assert.Equal(OwinInstrumentationActivitySource.IncomingRequestActivityName, activity.OperationName);
 
-                Assert.Equal(requestUri.Host + ":" + requestUri.Port, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpHost).Value);
-                Assert.Equal("GET", activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpMethod).Value);
-                Assert.Equal(requestUri.AbsolutePath, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpTarget).Value);
-                Assert.Equal(requestUri.ToString(), activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpUrl).Value);
+                Assert.Equal(requestUri.Host, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeServerAddress).Value);
+                Assert.Equal(requestUri.Port, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeServerPort).Value);
+                Assert.Equal("GET", activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpRequestMethod).Value);
+                Assert.Equal(requestUri.AbsolutePath, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeUrlPath).Value);
+                Assert.Equal(generateRemoteException ? 500 : 200, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpResponseStatusCode).Value);
 
-                Assert.Equal(generateRemoteException ? 500 : 200, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpStatusCode).Value);
                 if (generateRemoteException)
                 {
                     Assert.Equal(Status.Error, activity.GetStatus());
@@ -248,13 +248,13 @@ Owin has finished to inspect the activity status. */
             {
                 switch (tag.Key)
                 {
-                    case SemanticConventions.AttributeHttpMethod:
+                    case SemanticConventions.AttributeHttpRequestMethod:
                         Assert.Equal("GET", tag.Value);
                         break;
                     case SemanticConventions.AttributeHttpScheme:
                         Assert.Equal(requestUri.Scheme, tag.Value);
                         break;
-                    case SemanticConventions.AttributeHttpStatusCode:
+                    case SemanticConventions.AttributeHttpResponseStatusCode:
                         Assert.Equal(generateRemoteException ? 500 : 200, tag.Value);
                         break;
                 }
@@ -343,10 +343,10 @@ Owin has finished to inspect the activity status. */
             Activity activity = stoppedActivities[0];
             Assert.Equal(OwinInstrumentationActivitySource.IncomingRequestActivityName, activity.OperationName);
 
-            Assert.Equal(requestUri.Host + ":" + requestUri.Port, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpHost).Value);
-            Assert.Equal("GET", activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpMethod).Value);
-            Assert.Equal(requestUri.AbsolutePath, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpTarget).Value);
-            Assert.Equal(expectedRequestUri.ToString(), activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpUrl).Value);
+            Assert.Equal(requestUri.Host, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeServerAddress).Value);
+            Assert.Equal(requestUri.Port, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeServerPort).Value);
+            Assert.Equal("GET", activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeHttpRequestMethod).Value);
+            Assert.Equal(requestUri.AbsolutePath, activity.TagObjects.FirstOrDefault(t => t.Key == SemanticConventions.AttributeUrlPath).Value);
         }
         finally
         {