update HttpSemanticConventions for Instrumentation.Http (part2) (#4639)

open-telemetry · Jul 13, 2023 · 5c347ac · 5c347ac
1 parent 5b725de
commit 5c347ac
Show file tree

Hide file tree

Showing 6 changed files with 688 additions and 16 deletions.
diff --git a/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md
@@ -2,10 +2,12 @@
 
 ## Unreleased
 
-* Updated [Http Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/trace/semantic_conventions/http.md).
+* Updated [Http Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md).
   This library can emit either old, new, or both attributes. Users can control
   which attributes are emitted by setting the environment variable
   `OTEL_SEMCONV_STABILITY_OPT_IN`.
+  ([#4538](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4538))
+  ([#4639](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4639))
 
 ## 1.5.0-beta.1
 

diff --git a/src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs b/src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs
@@ -179,10 +179,9 @@ public void OnStartActivity(Activity activity, object payload)
                     activity.SetTag(SemanticConventions.AttributeHttpFlavor, HttpTagHelper.GetFlavorTagValueFromProtocolVersion(request.Version));
                 }
 
-                // see the spec https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/trace/semantic_conventions/http.md
+                // see the spec https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md
                 if (this.emitNewAttributes)
                 {
-                    activity.SetTag(SemanticConventions.AttributeUrlScheme, request.RequestUri.Scheme);
                     activity.SetTag(SemanticConventions.AttributeHttpRequestMethod, HttpTagHelper.GetNameForHttpMethod(request.Method));
                     activity.SetTag(SemanticConventions.AttributeServerAddress, request.RequestUri.Host);
                     if (!request.RequestUri.IsDefaultPort)

diff --git a/...OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerMetricsDiagnosticListener.cs b/...OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerMetricsDiagnosticListener.cs
@@ -79,11 +79,10 @@ public override void OnEventWritten(string name, object payload)
                         }
                     }
 
-                    // see the spec https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/trace/semantic_conventions/http.md
+                    // see the spec https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md
                     if (this.emitNewAttributes)
                     {
                         tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeHttpRequestMethod, HttpTagHelper.GetNameForHttpMethod(request.Method)));
-                        tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeUrlScheme, request.RequestUri.Scheme));
                         tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeNetworkProtocolVersion, HttpTagHelper.GetFlavorTagValueFromProtocolVersion(request.Version)));
                         tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeServerAddress, request.RequestUri.Host));
 

diff --git a/src/OpenTelemetry.Instrumentation.Http/Implementation/HttpWebRequestActivitySource.netfx.cs b/src/OpenTelemetry.Instrumentation.Http/Implementation/HttpWebRequestActivitySource.netfx.cs
@@ -23,6 +23,7 @@
 using System.Runtime.CompilerServices;
 using OpenTelemetry.Context.Propagation;
 using OpenTelemetry.Trace;
+using static OpenTelemetry.Internal.HttpSemanticConventionHelper;
 
 namespace OpenTelemetry.Instrumentation.Http.Implementation
 {
@@ -42,11 +43,14 @@ internal static class HttpWebRequestActivitySource
         internal static readonly Func<HttpWebRequest, string, IEnumerable<string>> HttpWebRequestHeaderValuesGetter = (request, name) => request.Headers.GetValues(name);
         internal static readonly Action<HttpWebRequest, string, string> HttpWebRequestHeaderValuesSetter = (request, name, value) => request.Headers.Add(name, value);
 
-        internal static HttpClientInstrumentationOptions Options = new HttpClientInstrumentationOptions();
-
         private static readonly Version Version = AssemblyName.Version;
         private static readonly ActivitySource WebRequestActivitySource = new ActivitySource(ActivitySourceName, Version.ToString());
 
+        private static HttpClientInstrumentationOptions options;
+
+        private static bool emitOldAttributes;
+        private static bool emitNewAttributes;
+
         // Fields for reflection
         private static FieldInfo connectionGroupListField;
         private static Type connectionGroupType;
@@ -81,6 +85,8 @@ static HttpWebRequestActivitySource()
             {
                 PrepareReflectionObjects();
                 PerformInjection();
+
+                Options = new HttpClientInstrumentationOptions();
             }
             catch (Exception ex)
             {
@@ -89,23 +95,53 @@ static HttpWebRequestActivitySource()
             }
         }
 
+        internal static HttpClientInstrumentationOptions Options
+        {
+            get => options;
+            set
+            {
+                options = value;
+
+                emitOldAttributes = value.HttpSemanticConvention.HasFlag(HttpSemanticConvention.Old);
+                emitNewAttributes = value.HttpSemanticConvention.HasFlag(HttpSemanticConvention.New);
+            }
+        }
+
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         private static void AddRequestTagsAndInstrumentRequest(HttpWebRequest request, Activity activity)
         {
             activity.DisplayName = HttpTagHelper.GetOperationNameForHttpMethod(request.Method);
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetTag(SemanticConventions.AttributeHttpMethod, request.Method);
-                activity.SetTag(SemanticConventions.AttributeNetPeerName, request.RequestUri.Host);
-                if (!request.RequestUri.IsDefaultPort)
+                // see the spec https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md
+                if (emitOldAttributes)
                 {
-                    activity.SetTag(SemanticConventions.AttributeNetPeerPort, request.RequestUri.Port);
+                    activity.SetTag(SemanticConventions.AttributeHttpMethod, request.Method);
+                    activity.SetTag(SemanticConventions.AttributeNetPeerName, request.RequestUri.Host);
+                    if (!request.RequestUri.IsDefaultPort)
+                    {
+                        activity.SetTag(SemanticConventions.AttributeNetPeerPort, request.RequestUri.Port);
+                    }
+
+                    activity.SetTag(SemanticConventions.AttributeHttpScheme, request.RequestUri.Scheme);
+                    activity.SetTag(SemanticConventions.AttributeHttpUrl, HttpTagHelper.GetUriTagValueFromRequestUri(request.RequestUri));
+                    activity.SetTag(SemanticConventions.AttributeHttpFlavor, HttpTagHelper.GetFlavorTagValueFromProtocolVersion(request.ProtocolVersion));
                 }
 
-                activity.SetTag(SemanticConventions.AttributeHttpScheme, request.RequestUri.Scheme);
-                activity.SetTag(SemanticConventions.AttributeHttpUrl, HttpTagHelper.GetUriTagValueFromRequestUri(request.RequestUri));
-                activity.SetTag(SemanticConventions.AttributeHttpFlavor, HttpTagHelper.GetFlavorTagValueFromProtocolVersion(request.ProtocolVersion));
+                // see the spec https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md
+                if (emitNewAttributes)
+                {
+                    activity.SetTag(SemanticConventions.AttributeHttpRequestMethod, request.Method);
+                    activity.SetTag(SemanticConventions.AttributeServerAddress, request.RequestUri.Host);
+                    if (!request.RequestUri.IsDefaultPort)
+                    {
+                        activity.SetTag(SemanticConventions.AttributeServerPort, request.RequestUri.Port);
+                    }
+
+                    activity.SetTag(SemanticConventions.AttributeUrlFull, HttpTagHelper.GetUriTagValueFromRequestUri(request.RequestUri));
+                    activity.SetTag(SemanticConventions.AttributeNetworkProtocolVersion, HttpTagHelper.GetFlavorTagValueFromProtocolVersion(request.ProtocolVersion));
+                }
 
                 try
                 {
@@ -123,7 +159,15 @@ private static void AddResponseTags(HttpWebResponse response, Activity activity)
         {
             if (activity.IsAllDataRequested)
             {
-                activity.SetTag(SemanticConventions.AttributeHttpStatusCode, TelemetryHelper.GetBoxedStatusCode(response.StatusCode));
+                if (emitOldAttributes)
+                {
+                    activity.SetTag(SemanticConventions.AttributeHttpStatusCode, TelemetryHelper.GetBoxedStatusCode(response.StatusCode));
+                }
+
+                if (emitNewAttributes)
+                {
+                    activity.SetTag(SemanticConventions.AttributeHttpResponseStatusCode, TelemetryHelper.GetBoxedStatusCode(response.StatusCode));
+                }
 
                 activity.SetStatus(SpanHelper.ResolveSpanStatusForHttpStatusCode(activity.Kind, (int)response.StatusCode));
 
@@ -153,7 +197,15 @@ private static void AddExceptionTags(Exception exception, Activity activity)
             {
                 if (wexc.Response is HttpWebResponse response)
                 {
-                    activity.SetTag(SemanticConventions.AttributeHttpStatusCode, (int)response.StatusCode);
+                    if (emitOldAttributes)
+                    {
+                        activity.SetTag(SemanticConventions.AttributeHttpStatusCode, (int)response.StatusCode);
+                    }
+
+                    if (emitNewAttributes)
+                    {
+                        activity.SetTag(SemanticConventions.AttributeHttpResponseStatusCode, (int)response.StatusCode);
+                    }
 
                     status = SpanHelper.ResolveSpanStatusForHttpStatusCode(activity.Kind, (int)response.StatusCode);
                 }