Merge pull request #435 from Strazz1337/fix-adhere-to-otel-spec

fix(spans): adhere attribute name to otel semver
microsoft · Oct 11, 2024 · 650812d · 650812d
2 parents 9ea5100 + 58496fa
commit 650812d
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.13.1] - 2024-10-10
+
+### Changed
+
+- Updated HTTP span attributes to comply with updated OpenTelemetry semantic conventions. [#344](https://github.com/microsoft/kiota-dotnet/issues/344)
+
 ## [1.13.0] - 2024-09-25
 
 ### Changed

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,7 +1,7 @@
 <Project>
   <!-- Common default project properties for ALL projects-->
   <PropertyGroup>
-    <VersionPrefix>1.13.0</VersionPrefix>
+    <VersionPrefix>1.13.1</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <!-- This is overidden in test projects by setting to true-->
     <IsTestProject>false</IsTestProject>

diff --git a/src/http/httpClient/HttpClientRequestAdapter.cs b/src/http/httpClient/HttpClientRequestAdapter.cs
@@ -78,7 +78,7 @@ public string? BaseUrl
             var decodedUriTemplate = ParametersNameDecodingHandler.DecodeUriEncodedString(requestInfo.UrlTemplate, charactersToDecodeForUriTemplate);
             var telemetryPathValue = string.IsNullOrEmpty(decodedUriTemplate) ? string.Empty : queryParametersCleanupRegex.Replace(decodedUriTemplate, string.Empty);
             var span = activitySource?.StartActivity($"{methodName} - {telemetryPathValue}");
-            span?.SetTag("http.uri_template", decodedUriTemplate);
+            span?.SetTag("url.uri_template", decodedUriTemplate);
             return span;
         }
         /// <summary>
@@ -519,19 +519,19 @@ private async Task<HttpResponseMessage> GetHttpResponseMessageAsync(RequestInfor
                 using var contentLengthEnumerator = contentLengthValues.GetEnumerator();
                 if(contentLengthEnumerator.MoveNext() && int.TryParse(contentLengthEnumerator.Current, out var contentLength))
                 {
-                    activityForAttributes?.SetTag("http.response_content_length", contentLength);
+                    activityForAttributes?.SetTag("http.response.body.size", contentLength);
                 }
             }
             if(response.Headers.TryGetValues("Content-Type", out var contentTypeValues))
             {
                 using var contentTypeEnumerator = contentTypeValues.GetEnumerator();
                 if(contentTypeEnumerator.MoveNext())
                 {
-                    activityForAttributes?.SetTag("http.response_content_type", contentTypeEnumerator.Current);
+                    activityForAttributes?.SetTag("http.response.header.content-type", contentTypeEnumerator.Current);
                 }
             }
-            activityForAttributes?.SetTag("http.status_code", (int)response.StatusCode);
-            activityForAttributes?.SetTag("http.flavor", $"{response.Version.Major}.{response.Version.Minor}");
+            activityForAttributes?.SetTag("http.response.status_code", (int)response.StatusCode);
+            activityForAttributes?.SetTag("network.protocol.name", $"{response.Version.Major}.{response.Version.Minor}");
 
             return await RetryCAEResponseIfRequiredAsync(response, requestInfo, cancellationToken, claims, activityForAttributes).ConfigureAwait(false);
         }
@@ -612,12 +612,12 @@ private HttpRequestMessage GetRequestMessageFromRequestInformation(RequestInform
         {
             using var span = activitySource?.StartActivity(nameof(GetRequestMessageFromRequestInformation));
             SetBaseUrlForRequestInformation(requestInfo);// this method can also be called from a different context so ensure the baseUrl is added.
-            activityForAttributes?.SetTag("http.method", requestInfo.HttpMethod.ToString());
+            activityForAttributes?.SetTag("http.request.method", requestInfo.HttpMethod.ToString());
             var requestUri = requestInfo.URI;
-            activityForAttributes?.SetTag("http.host", requestUri.Host);
-            activityForAttributes?.SetTag("http.scheme", requestUri.Scheme);
+            activityForAttributes?.SetTag("url.scheme", requestUri.Host);
+            activityForAttributes?.SetTag("server.address", requestUri.Scheme);
             if(obsOptions.IncludeEUIIAttributes)
-                activityForAttributes?.SetTag("http.uri", requestUri.ToString());
+                activityForAttributes?.SetTag("url.full", requestUri.ToString());
             var message = new HttpRequestMessage
             {
                 Method = new HttpMethod(requestInfo.HttpMethod.ToString().ToUpperInvariant()),
@@ -653,13 +653,13 @@ private HttpRequestMessage GetRequestMessageFromRequestInformation(RequestInform
                 {
                     var contentLenEnumerator = contentLenValues.GetEnumerator();
                     if(contentLenEnumerator.MoveNext() && int.TryParse(contentLenEnumerator.Current, out var contentLenValueInt))
-                        activityForAttributes?.SetTag("http.request_content_length", contentLenValueInt);
+                        activityForAttributes?.SetTag("http.request.body.size", contentLenValueInt);
                 }
                 if(message.Content.Headers.TryGetValues("Content-Type", out var contentTypeValues))
                 {
                     var contentTypeEnumerator = contentTypeValues.GetEnumerator();
                     if(contentTypeEnumerator.MoveNext())
-                        activityForAttributes?.SetTag("http.request_content_type", contentTypeEnumerator.Current);
+                        activityForAttributes?.SetTag("http.request.header.content-type", contentTypeEnumerator.Current);
                 }
             }
             return message;

diff --git a/src/http/httpClient/Middleware/RedirectHandler.cs b/src/http/httpClient/Middleware/RedirectHandler.cs
@@ -82,7 +82,7 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
                     {
                         using var redirectActivity = activitySource?.StartActivity($"{nameof(RedirectHandler)}_{nameof(SendAsync)} - redirect {redirectCount}");
                         redirectActivity?.SetTag("com.microsoft.kiota.handler.redirect.count", redirectCount);
-                        redirectActivity?.SetTag("http.status_code", response.StatusCode);
+                        redirectActivity?.SetTag("http.response.status_code", response.StatusCode);
                         // Drain response content to free responses.
                         if(response.Content != null)
                         {

diff --git a/src/http/httpClient/Middleware/RetryHandler.cs b/src/http/httpClient/Middleware/RetryHandler.cs
@@ -106,7 +106,7 @@ private async Task<HttpResponseMessage> SendRetryAsync(HttpResponseMessage respo
                 exceptions.Add(await GetInnerExceptionAsync(response).ConfigureAwait(false));
                 using var retryActivity = activitySource?.StartActivity($"{nameof(RetryHandler)}_{nameof(SendAsync)} - attempt {retryCount}");
                 retryActivity?.SetTag("http.retry_count", retryCount);
-                retryActivity?.SetTag("http.status_code", response.StatusCode);
+                retryActivity?.SetTag("http.response.status_code", response.StatusCode);
 
                 // Call Delay method to get delay time from response's Retry-After header or by exponential backoff
                 Task delay = RetryHandler.DelayAsync(response, retryCount, retryOption.Delay, out double delayInSeconds, cancellationToken);