Change OpenTelemetryChatClient/EmbeddingGenerator to log raw additional properties (#6776)

stephentoub · web-flow · commit 3645ccc33d29 · 2025-09-06T18:51:58.000-04:00
For historical reasons (based on older versions of the genai convention), we were mangling the key names. Now just use the key names as sourced from the dictionary, enabling a developer to more easily augment the spans with data of their choice.
diff --git a/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/OpenTelemetryChatClient.cs b/src/Libraries/Microsoft.Extensions.AI/ChatCompletion/OpenTelemetryChatClient.cs
@@ -364,20 +364,13 @@ private static string SerializeChatMessages(IEnumerable<ChatMessage> messages, C
                         }
                     }
 
-                    if (_providerName is not null)
+                    // Log all additional request options as raw values on the span.
+                    // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.
+                    if (EnableSensitiveData && options.AdditionalProperties is { } props)
                     {
-                        // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data
-                        if (EnableSensitiveData && options.AdditionalProperties is { } props)
+                        foreach (KeyValuePair<string, object?> prop in props)
                         {
-                            // Log all additional request options as per-provider tags. This is non-normative, but it covers cases where
-                            // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.request.service_tier),
-                            // and more generally cases where there's additional useful information to be logged.
-                            foreach (KeyValuePair<string, object?> prop in props)
-                            {
-                                _ = activity.AddTag(
-                                    OpenTelemetryConsts.GenAI.Request.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),
-                                    prop.Value);
-                            }
+                            _ = activity.AddTag(prop.Key, prop.Value);
                         }
                     }
                 }
@@ -467,20 +460,13 @@ private void TraceResponse(
                     _ = activity.AddTag(OpenTelemetryConsts.GenAI.Usage.OutputTokens, (int)outputTokens);
                 }
 
-                if (_providerName is not null)
+                // Log all additional response properties as raw values on the span.
+                // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.
+                if (EnableSensitiveData && response.AdditionalProperties is { } props)
                 {
-                    // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data
-                    if (EnableSensitiveData && response.AdditionalProperties is { } props)
+                    foreach (KeyValuePair<string, object?> prop in props)
                     {
-                        // Log all additional response properties as per-provider tags. This is non-normative, but it covers cases where
-                        // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.response.system_fingerprint),
-                        // and more generally cases where there's additional useful information to be logged.
-                        foreach (KeyValuePair<string, object?> prop in props)
-                        {
-                            _ = activity.AddTag(
-                                OpenTelemetryConsts.GenAI.Response.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),
-                                prop.Value);
-                        }
+                        _ = activity.AddTag(prop.Key, prop.Value);
                     }
                 }
             }
diff --git a/src/Libraries/Microsoft.Extensions.AI/Embeddings/OpenTelemetryEmbeddingGenerator.cs b/src/Libraries/Microsoft.Extensions.AI/Embeddings/OpenTelemetryEmbeddingGenerator.cs
@@ -6,7 +6,6 @@
 using System.Diagnostics;
 using System.Diagnostics.Metrics;
 using System.Linq;
-using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
@@ -175,19 +174,13 @@ protected override void Dispose(bool disposing)
                     _ = activity.AddTag(OpenTelemetryConsts.GenAI.Request.EmbeddingDimensions, dimensionsValue);
                 }
 
-                // Log all additional request options as per-provider tags. This is non-normative, but it covers cases where
-                // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.request.service_tier),
-                // and more generally cases where there's additional useful information to be logged.
+                // Log all additional request options as raw values on the span.
                 // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.
-                if (EnableSensitiveData &&
-                    _providerName is not null &&
-                    options?.AdditionalProperties is { } props)
+                if (EnableSensitiveData && options?.AdditionalProperties is { } props)
                 {
                     foreach (KeyValuePair<string, object?> prop in props)
                     {
-                        _ = activity.AddTag(
-                            OpenTelemetryConsts.GenAI.Request.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),
-                            prop.Value);
+                        _ = activity.AddTag(prop.Key, prop.Value);
                     }
                 }
             }
@@ -255,18 +248,13 @@ private void TraceResponse(
                 _ = activity.AddTag(OpenTelemetryConsts.GenAI.Response.Model, responseModelId);
             }
 
-            // Log all additional response properties as per-provider tags. This is non-normative, but it covers cases where
-            // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.response.system_fingerprint),
-            // and more generally cases where there's additional useful information to be logged.
-            if (EnableSensitiveData &&
-                _providerName is not null &&
-                embeddings?.AdditionalProperties is { } props)
+            // Log all additional response properties as raw values on the span.
+            // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.
+            if (EnableSensitiveData && embeddings?.AdditionalProperties is { } props)
             {
                 foreach (KeyValuePair<string, object?> prop in props)
                 {
-                    _ = activity.AddTag(
-                        OpenTelemetryConsts.GenAI.Response.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),
-                        prop.Value);
+                    _ = activity.AddTag(prop.Key, prop.Value);
                 }
             }
         }
diff --git a/src/Libraries/Microsoft.Extensions.AI/OpenTelemetryConsts.cs b/src/Libraries/Microsoft.Extensions.AI/OpenTelemetryConsts.cs
@@ -90,17 +90,13 @@ public static class Request
             public const string Temperature = "gen_ai.request.temperature";
             public const string TopK = "gen_ai.request.top_k";
             public const string TopP = "gen_ai.request.top_p";
-
-            public static string PerProvider(string providerName, string parameterName) => $"{providerName}.request.{parameterName}";
         }
 
         public static class Response
         {
             public const string FinishReasons = "gen_ai.response.finish_reasons";
             public const string Id = "gen_ai.response.id";
             public const string Model = "gen_ai.response.model";
-
-            public static string PerProvider(string providerName, string parameterName) => $"{providerName}.response.{parameterName}";
         }
 
         public static class Token
diff --git a/test/Libraries/Microsoft.Extensions.AI.Tests/ChatCompletion/OpenTelemetryChatClientTests.cs b/test/Libraries/Microsoft.Extensions.AI.Tests/ChatCompletion/OpenTelemetryChatClientTests.cs
@@ -163,16 +163,16 @@ async static IAsyncEnumerable<ChatResponseUpdate> CallbackAsync(
         Assert.Equal(7, activity.GetTagItem("gen_ai.request.top_k"));
         Assert.Equal(123, activity.GetTagItem("gen_ai.request.max_tokens"));
         Assert.Equal("""["hello", "world"]""", activity.GetTagItem("gen_ai.request.stop_sequences"));
-        Assert.Equal(enableSensitiveData ? "value1" : null, activity.GetTagItem("testservice.request.service_tier"));
-        Assert.Equal(enableSensitiveData ? "value2" : null, activity.GetTagItem("testservice.request.something_else"));
+        Assert.Equal(enableSensitiveData ? "value1" : null, activity.GetTagItem("service_tier"));
+        Assert.Equal(enableSensitiveData ? "value2" : null, activity.GetTagItem("SomethingElse"));
         Assert.Equal(42L, activity.GetTagItem("gen_ai.request.seed"));
 
         Assert.Equal("id123", activity.GetTagItem("gen_ai.response.id"));
         Assert.Equal("""["stop"]""", activity.GetTagItem("gen_ai.response.finish_reasons"));
         Assert.Equal(10, activity.GetTagItem("gen_ai.usage.input_tokens"));
         Assert.Equal(20, activity.GetTagItem("gen_ai.usage.output_tokens"));
-        Assert.Equal(enableSensitiveData ? "abcdefgh" : null, activity.GetTagItem("testservice.response.system_fingerprint"));
-        Assert.Equal(enableSensitiveData ? "value2" : null, activity.GetTagItem("testservice.response.and_something_else"));
+        Assert.Equal(enableSensitiveData ? "abcdefgh" : null, activity.GetTagItem("system_fingerprint"));
+        Assert.Equal(enableSensitiveData ? "value2" : null, activity.GetTagItem("AndSomethingElse"));
 
         Assert.True(activity.Duration.TotalMilliseconds > 0);
 
diff --git a/test/Libraries/Microsoft.Extensions.AI.Tests/Embeddings/OpenTelemetryEmbeddingGeneratorTests.cs b/test/Libraries/Microsoft.Extensions.AI.Tests/Embeddings/OpenTelemetryEmbeddingGeneratorTests.cs
@@ -86,12 +86,12 @@ public async Task ExpectedInformationLogged_Async(string? perRequestModelId, boo
 
         Assert.Equal(expectedModelName, activity.GetTagItem("gen_ai.request.model"));
         Assert.Equal(1234, activity.GetTagItem("gen_ai.request.embedding.dimensions"));
-        Assert.Equal(enableSensitiveData ? "value1" : null, activity.GetTagItem("testservice.request.service_tier"));
-        Assert.Equal(enableSensitiveData ? "value2" : null, activity.GetTagItem("testservice.request.something_else"));
+        Assert.Equal(enableSensitiveData ? "value1" : null, activity.GetTagItem("service_tier"));
+        Assert.Equal(enableSensitiveData ? "value2" : null, activity.GetTagItem("SomethingElse"));
 
         Assert.Equal(10, activity.GetTagItem("gen_ai.usage.input_tokens"));
-        Assert.Equal(enableSensitiveData ? "abcdefgh" : null, activity.GetTagItem("testservice.response.system_fingerprint"));
-        Assert.Equal(enableSensitiveData ? "value3" : null, activity.GetTagItem("testservice.response.and_something_else"));
+        Assert.Equal(enableSensitiveData ? "abcdefgh" : null, activity.GetTagItem("system_fingerprint"));
+        Assert.Equal(enableSensitiveData ? "value3" : null, activity.GetTagItem("AndSomethingElse"));
 
         Assert.True(activity.Duration.TotalMilliseconds > 0);
     }

Original file line number	Diff line number	Diff line change
`@@ -364,20 +364,13 @@ private static string SerializeChatMessages(IEnumerable<ChatMessage> messages, C`
`364`	`364`	`}`
`365`	`365`	`}`
`366`	`366`
`367`		`- if (_providerName is not null)`
	`367`	`+ // Log all additional request options as raw values on the span.`
	`368`	`+ // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.`
	`369`	`+ if (EnableSensitiveData && options.AdditionalProperties is { } props)`
`368`	`370`	`{`
`369`		`- // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data`
`370`		`- if (EnableSensitiveData && options.AdditionalProperties is { } props)`
	`371`	`+ foreach (KeyValuePair<string, object?> prop in props)`
`371`	`372`	`{`
`372`		`- // Log all additional request options as per-provider tags. This is non-normative, but it covers cases where`
`373`		`- // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.request.service_tier),`
`374`		`- // and more generally cases where there's additional useful information to be logged.`
`375`		`- foreach (KeyValuePair<string, object?> prop in props)`
`376`		`- {`
`377`		`- _ = activity.AddTag(`
`378`		`- OpenTelemetryConsts.GenAI.Request.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),`
`379`		`- prop.Value);`
`380`		`- }`
	`373`	`+ _ = activity.AddTag(prop.Key, prop.Value);`
`381`	`374`	`}`
`382`	`375`	`}`
`383`	`376`	`}`
`@@ -467,20 +460,13 @@ private void TraceResponse(`
`467`	`460`	`_ = activity.AddTag(OpenTelemetryConsts.GenAI.Usage.OutputTokens, (int)outputTokens);`
`468`	`461`	`}`
`469`	`462`
`470`		`- if (_providerName is not null)`
	`463`	`+ // Log all additional response properties as raw values on the span.`
	`464`	`+ // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.`
	`465`	`+ if (EnableSensitiveData && response.AdditionalProperties is { } props)`
`471`	`466`	`{`
`472`		`- // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data`
`473`		`- if (EnableSensitiveData && response.AdditionalProperties is { } props)`
	`467`	`+ foreach (KeyValuePair<string, object?> prop in props)`
`474`	`468`	`{`
`475`		`- // Log all additional response properties as per-provider tags. This is non-normative, but it covers cases where`
`476`		`- // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.response.system_fingerprint),`
`477`		`- // and more generally cases where there's additional useful information to be logged.`
`478`		`- foreach (KeyValuePair<string, object?> prop in props)`
`479`		`- {`
`480`		`- _ = activity.AddTag(`
`481`		`- OpenTelemetryConsts.GenAI.Response.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),`
`482`		`- prop.Value);`
`483`		`- }`
	`469`	`+ _ = activity.AddTag(prop.Key, prop.Value);`
`484`	`470`	`}`
`485`	`471`	`}`
`486`	`472`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@`
`6`	`6`	`using System.Diagnostics;`
`7`	`7`	`using System.Diagnostics.Metrics;`
`8`	`8`	`using System.Linq;`
`9`		`-using System.Text.Json;`
`10`	`9`	`using System.Threading;`
`11`	`10`	`using System.Threading.Tasks;`
`12`	`11`	`using Microsoft.Extensions.Logging;`
`@@ -175,19 +174,13 @@ protected override void Dispose(bool disposing)`
`175`	`174`	`_ = activity.AddTag(OpenTelemetryConsts.GenAI.Request.EmbeddingDimensions, dimensionsValue);`
`176`	`175`	`}`
`177`	`176`
`178`		`- // Log all additional request options as per-provider tags. This is non-normative, but it covers cases where`
`179`		`- // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.request.service_tier),`
`180`		`- // and more generally cases where there's additional useful information to be logged.`
	`177`	`+ // Log all additional request options as raw values on the span.`
`181`	`178`	`// Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.`
`182`		`- if (EnableSensitiveData &&`
`183`		`- _providerName is not null &&`
`184`		`- options?.AdditionalProperties is { } props)`
	`179`	`+ if (EnableSensitiveData && options?.AdditionalProperties is { } props)`
`185`	`180`	`{`
`186`	`181`	`foreach (KeyValuePair<string, object?> prop in props)`
`187`	`182`	`{`
`188`		`- _ = activity.AddTag(`
`189`		`- OpenTelemetryConsts.GenAI.Request.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),`
`190`		`- prop.Value);`
	`183`	`+ _ = activity.AddTag(prop.Key, prop.Value);`
`191`	`184`	`}`
`192`	`185`	`}`
`193`	`186`	`}`
`@@ -255,18 +248,13 @@ private void TraceResponse(`
`255`	`248`	`_ = activity.AddTag(OpenTelemetryConsts.GenAI.Response.Model, responseModelId);`
`256`	`249`	`}`
`257`	`250`
`258`		`- // Log all additional response properties as per-provider tags. This is non-normative, but it covers cases where`
`259`		`- // there's a per-provider specification in a best-effort manner (e.g. gen_ai.openai.response.system_fingerprint),`
`260`		`- // and more generally cases where there's additional useful information to be logged.`
`261`		`- if (EnableSensitiveData &&`
`262`		`- _providerName is not null &&`
`263`		`- embeddings?.AdditionalProperties is { } props)`
	`251`	`+ // Log all additional response properties as raw values on the span.`
	`252`	`+ // Since AdditionalProperties has undefined meaning, we treat it as potentially sensitive data.`
	`253`	`+ if (EnableSensitiveData && embeddings?.AdditionalProperties is { } props)`
`264`	`254`	`{`
`265`	`255`	`foreach (KeyValuePair<string, object?> prop in props)`
`266`	`256`	`{`
`267`		`- _ = activity.AddTag(`
`268`		`- OpenTelemetryConsts.GenAI.Response.PerProvider(_providerName, JsonNamingPolicy.SnakeCaseLower.ConvertName(prop.Key)),`
`269`		`- prop.Value);`
	`257`	`+ _ = activity.AddTag(prop.Key, prop.Value);`
`270`	`258`	`}`
`271`	`259`	`}`
`272`	`260`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,17 +90,13 @@ public static class Request`
`90`	`90`	`public const string Temperature = "gen_ai.request.temperature";`
`91`	`91`	`public const string TopK = "gen_ai.request.top_k";`
`92`	`92`	`public const string TopP = "gen_ai.request.top_p";`
`93`		`-`
`94`		`- public static string PerProvider(string providerName, string parameterName) => $"{providerName}.request.{parameterName}";`
`95`	`93`	`}`
`96`	`94`
`97`	`95`	`public static class Response`
`98`	`96`	`{`
`99`	`97`	`public const string FinishReasons = "gen_ai.response.finish_reasons";`
`100`	`98`	`public const string Id = "gen_ai.response.id";`
`101`	`99`	`public const string Model = "gen_ai.response.model";`
`102`		`-`
`103`		`- public static string PerProvider(string providerName, string parameterName) => $"{providerName}.response.{parameterName}";`
`104`	`100`	`}`
`105`	`101`
`106`	`102`	`public static class Token`