[shared] Tag transformer improvements (#5455)

Co-authored-by: Utkarsh Umesan Pillai <[email protected]>
open-telemetry · Mar 22, 2024 · 49f16e4 · 49f16e4
1 parent 2f0af65
commit 49f16e4
Show file tree

Hide file tree

Showing 24 changed files with 302 additions and 213 deletions.
diff --git a/OpenTelemetry.sln b/OpenTelemetry.sln
@@ -275,7 +275,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Shared", "Shared", "{A49299
 		src\Shared\SpanAttributeConstants.cs = src\Shared\SpanAttributeConstants.cs
 		src\Shared\SpanHelper.cs = src\Shared\SpanHelper.cs
 		src\Shared\StatusHelper.cs = src\Shared\StatusHelper.cs
-		src\Shared\TagAndValueTransformer.cs = src\Shared\TagAndValueTransformer.cs
 		src\Shared\TagTransformer.cs = src\Shared\TagTransformer.cs
 		src\Shared\TagTransformerJsonHelper.cs = src\Shared\TagTransformerJsonHelper.cs
 	EndProjectSection

diff --git a/src/OpenTelemetry.Exporter.Console/ConsoleActivityExporter.cs b/src/OpenTelemetry.Exporter.Console/ConsoleActivityExporter.cs
@@ -56,7 +56,7 @@ public override ExportResult Export(in Batch<Activity> batch)
                         continue;
                     }
 
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(tag, out var result))
+                    if (this.TagTransformer.TryTransformTag(tag, out var result))
                     {
                         this.WriteLine($"    {result}");
                     }
@@ -88,7 +88,7 @@ public override ExportResult Export(in Batch<Activity> batch)
                     this.WriteLine($"    {activityEvent.Name} [{activityEvent.Timestamp}]");
                     foreach (ref readonly var attribute in activityEvent.EnumerateTagObjects())
                     {
-                        if (ConsoleTagTransformer.Instance.TryTransformTag(attribute, out var result))
+                        if (this.TagTransformer.TryTransformTag(attribute, out var result))
                         {
                             this.WriteLine($"        {result}");
                         }
@@ -104,7 +104,7 @@ public override ExportResult Export(in Batch<Activity> batch)
                     this.WriteLine($"    {activityLink.Context.TraceId} {activityLink.Context.SpanId}");
                     foreach (ref readonly var attribute in activityLink.EnumerateTagObjects())
                     {
-                        if (ConsoleTagTransformer.Instance.TryTransformTag(attribute, out var result))
+                        if (this.TagTransformer.TryTransformTag(attribute, out var result))
                         {
                             this.WriteLine($"        {result}");
                         }
@@ -118,7 +118,7 @@ public override ExportResult Export(in Batch<Activity> batch)
                 this.WriteLine("Resource associated with Activity:");
                 foreach (var resourceAttribute in resource.Attributes)
                 {
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(resourceAttribute, out var result))
+                    if (this.TagTransformer.TryTransformTag(resourceAttribute, out var result))
                     {
                         this.WriteLine($"    {result}");
                     }

diff --git a/src/OpenTelemetry.Exporter.Console/ConsoleExporter.cs b/src/OpenTelemetry.Exporter.Console/ConsoleExporter.cs
@@ -11,12 +11,12 @@ public abstract class ConsoleExporter<T> : BaseExporter<T>
     protected ConsoleExporter(ConsoleExporterOptions options)
     {
         this.options = options ?? new ConsoleExporterOptions();
-        ConsoleTagTransformer.LogUnsupportedAttributeType = (string tagValueType, string tagKey) =>
-        {
-            this.WriteLine($"Unsupported attribute type {tagValueType} for {tagKey}.");
-        };
+
+        this.TagTransformer = new ConsoleTagTransformer(this.OnUnsupportedTagDropped);
     }
 
+    internal ConsoleTagTransformer TagTransformer { get; }
+
     protected void WriteLine(string message)
     {
         if (this.options.Targets.HasFlag(ConsoleExporterOutputTargets.Console))
@@ -29,4 +29,11 @@ protected void WriteLine(string message)
             System.Diagnostics.Trace.WriteLine(message);
         }
     }
+
+    private void OnUnsupportedTagDropped(
+        string tagKey,
+        string tagValueTypeFullName)
+    {
+        this.WriteLine($"Unsupported attribute value type '{tagValueTypeFullName}' for '{tagKey}'.");
+    }
 }
diff --git a/src/OpenTelemetry.Exporter.Console/ConsoleLogRecordExporter.cs b/src/OpenTelemetry.Exporter.Console/ConsoleLogRecordExporter.cs
@@ -93,7 +93,7 @@ public override ExportResult Export(in Batch<LogRecord> batch)
                         ? new KeyValuePair<string, object>("OriginalFormat (a.k.a Body)", logRecord.Attributes[i].Value)
                         : logRecord.Attributes[i];
 
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(valueToTransform, out var result))
+                    if (this.TagTransformer.TryTransformTag(valueToTransform, out var result))
                     {
                         this.WriteLine($"{string.Empty,-4}{result}");
                     }
@@ -127,7 +127,7 @@ void ProcessScope(LogRecordScope scope, ConsoleLogRecordExporter exporter)
 
                 foreach (KeyValuePair<string, object> scopeItem in scope)
                 {
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(scopeItem, out var result))
+                    if (this.TagTransformer.TryTransformTag(scopeItem, out var result))
                     {
                         exporter.WriteLine($"[Scope.{scopeDepth}]:{result}");
                     }
@@ -140,7 +140,7 @@ void ProcessScope(LogRecordScope scope, ConsoleLogRecordExporter exporter)
                 this.WriteLine("\nResource associated with LogRecord:");
                 foreach (var resourceAttribute in resource.Attributes)
                 {
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(resourceAttribute, out var result))
+                    if (this.TagTransformer.TryTransformTag(resourceAttribute, out var result))
                     {
                         this.WriteLine(result);
                     }

diff --git a/src/OpenTelemetry.Exporter.Console/ConsoleMetricExporter.cs b/src/OpenTelemetry.Exporter.Console/ConsoleMetricExporter.cs
@@ -27,7 +27,7 @@ public override ExportResult Export(in Batch<Metric> batch)
                 this.WriteLine("Resource associated with Metric:");
                 foreach (var resourceAttribute in this.resource.Attributes)
                 {
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(resourceAttribute, out var result))
+                    if (this.TagTransformer.TryTransformTag(resourceAttribute, out var result))
                     {
                         this.WriteLine($"    {result}");
                     }
@@ -67,7 +67,7 @@ public override ExportResult Export(in Batch<Metric> batch)
                 foreach (var meterTag in metric.MeterTags)
                 {
                     this.WriteLine("\tMeter Tags:");
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(meterTag, out var result))
+                    if (this.TagTransformer.TryTransformTag(meterTag, out var result))
                     {
                         this.WriteLine($"\t\t{result}");
                     }
@@ -80,7 +80,7 @@ public override ExportResult Export(in Batch<Metric> batch)
                 StringBuilder tagsBuilder = new StringBuilder();
                 foreach (var tag in metricPoint.Tags)
                 {
-                    if (ConsoleTagTransformer.Instance.TryTransformTag(tag, out var result))
+                    if (this.TagTransformer.TryTransformTag(tag, out var result))
                     {
                         tagsBuilder.Append(result);
                         tagsBuilder.Append(' ');
@@ -216,7 +216,7 @@ public override ExportResult Export(in Batch<Metric> batch)
                         bool appendedTagString = false;
                         foreach (var tag in exemplar.FilteredTags)
                         {
-                            if (ConsoleTagTransformer.Instance.TryTransformTag(tag, out var result))
+                            if (this.TagTransformer.TryTransformTag(tag, out var result))
                             {
                                 if (!appendedTagString)
                                 {

diff --git a/...Exporter.Console/ConsoleTagTransformer.cs → ...e/Implementation/ConsoleTagTransformer.cs b/...Exporter.Console/ConsoleTagTransformer.cs → ...e/Implementation/ConsoleTagTransformer.cs
@@ -1,17 +1,23 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
+using System.Diagnostics;
 using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Exporter;
 
 internal sealed class ConsoleTagTransformer : TagTransformer<string>
 {
-    private ConsoleTagTransformer()
+    private readonly Action<string, string> onUnsupportedTagDropped;
+
+    public ConsoleTagTransformer(Action<string, string> onUnsupportedTagDropped)
     {
-    }
+        Debug.Assert(onUnsupportedTagDropped != null, "onUnsupportedTagDropped was null");
 
-    public static ConsoleTagTransformer Instance { get; } = new();
+        this.onUnsupportedTagDropped = onUnsupportedTagDropped!;
+    }
 
     protected override string TransformIntegralTag(string key, long value) => $"{key}: {value}";
 
@@ -23,4 +29,11 @@ private ConsoleTagTransformer()
 
     protected override string TransformArrayTag(string key, Array array)
         => this.TransformStringTag(key, TagTransformerJsonHelper.JsonSerializeArrayTag(array));
+
+    protected override void OnUnsupportedTagDropped(
+        string tagKey,
+        string tagValueTypeFullName)
+    {
+        this.onUnsupportedTagDropped(tagKey, tagValueTypeFullName);
+    }
 }
diff --git a/src/OpenTelemetry.Exporter.Console/OpenTelemetry.Exporter.Console.csproj b/src/OpenTelemetry.Exporter.Console/OpenTelemetry.Exporter.Console.csproj
@@ -34,6 +34,7 @@
     <Compile Include="$(RepoRoot)\src\Shared\Guard.cs" Link="Includes\Guard.cs" RequiresExposedExperimentalFeatures="true" />
     <Compile Include="$(RepoRoot)\src\Shared\DiagnosticDefinitions.cs" Link="Includes\DiagnosticDefinitions.cs" RequiresExposedExperimentalFeatures="true" />
     <Compile Include="$(RepoRoot)\src\Shared\ExceptionExtensions.cs" Link="Includes\ExceptionExtensions.cs" RequiresExposedExperimentalFeatures="true" />
+    <Compile Include="$(RepoRoot)\src\Shared\Shims\NullableAttributes.cs" Link="Includes\Shims\NullableAttributes.cs" RequiresExposedExperimentalFeatures="true" />
     <Compile Include="$(RepoRoot)\src\Shared\SpanAttributeConstants.cs" Link="Includes\SpanAttributeConstants.cs" RequiresExposedExperimentalFeatures="true" />
   </ItemGroup>
 

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ActivityExtensions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ActivityExtensions.cs
@@ -237,7 +237,7 @@ private static Span.Types.Link ToOtlpLink(in ActivityLink activityLink, SdkLimit
         int maxTags = sdkLimitOptions.SpanLinkAttributeCountLimit ?? int.MaxValue;
         foreach (ref readonly var tag in activityLink.EnumerateTagObjects())
         {
-            if (OtlpKeyValueTransformer.Instance.TryTransformTag(tag, out var attribute, sdkLimitOptions.AttributeValueLengthLimit))
+            if (OtlpTagTransformer.Instance.TryTransformTag(tag, out var attribute, sdkLimitOptions.AttributeValueLengthLimit))
             {
                 if (otlpLink.Attributes.Count < maxTags)
                 {
@@ -265,7 +265,7 @@ private static Span.Types.Event ToOtlpEvent(in ActivityEvent activityEvent, SdkL
         int maxTags = sdkLimitOptions.SpanEventAttributeCountLimit ?? int.MaxValue;
         foreach (ref readonly var tag in activityEvent.EnumerateTagObjects())
         {
-            if (OtlpKeyValueTransformer.Instance.TryTransformTag(tag, out var attribute, sdkLimitOptions.AttributeValueLengthLimit))
+            if (OtlpTagTransformer.Instance.TryTransformTag(tag, out var attribute, sdkLimitOptions.AttributeValueLengthLimit))
             {
                 if (otlpEvent.Attributes.Count < maxTags)
                 {
@@ -322,7 +322,7 @@ public void EnumerateTags(Activity activity, int maxTags)
                         continue;
                 }
 
-                if (OtlpKeyValueTransformer.Instance.TryTransformTag(tag, out var attribute, this.SdkLimitOptions.AttributeValueLengthLimit))
+                if (OtlpTagTransformer.Instance.TryTransformTag(tag, out var attribute, this.SdkLimitOptions.AttributeValueLengthLimit))
                 {
                     if (this.Span.Attributes.Count < maxTags)
                     {

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/MetricItemExtensions.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/MetricItemExtensions.cs
@@ -416,7 +416,7 @@ internal static OtlpMetrics.Exemplar ToOtlpExemplar<T>(T value, in Metrics.Exemp
 
         foreach (var tag in exemplar.FilteredTags)
         {
-            if (OtlpKeyValueTransformer.Instance.TryTransformTag(tag, out var result))
+            if (OtlpTagTransformer.Instance.TryTransformTag(tag, out var result))
             {
                 otlpExemplar.FilteredAttributes.Add(result);
             }
@@ -429,7 +429,7 @@ private static void AddAttributes(ReadOnlyTagCollection tags, RepeatedField<Otlp
     {
         foreach (var tag in tags)
         {
-            if (OtlpKeyValueTransformer.Instance.TryTransformTag(tag, out var result))
+            if (OtlpTagTransformer.Instance.TryTransformTag(tag, out var result))
             {
                 attributes.Add(result);
             }
@@ -440,7 +440,7 @@ private static void AddScopeAttributes(IEnumerable<KeyValuePair<string, object>>
     {
         foreach (var tag in meterTags)
         {
-            if (OtlpKeyValueTransformer.Instance.TryTransformTag(tag, out var result))
+            if (OtlpTagTransformer.Instance.TryTransformTag(tag, out var result))
             {
                 attributes.Add(result);
             }

diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OtlpKeyValueTransformer.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OtlpKeyValueTransformer.cs
diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OtlpLogRecordTransformer.cs b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/OtlpLogRecordTransformer.cs
@@ -166,7 +166,7 @@ internal OtlpLogs.LogRecord ToOtlpLog(LogRecord logRecord)
                     {
                         otlpLogRecord.Body = new OtlpCommon.AnyValue { StringValue = attribute.Value as string };
                     }
-                    else if (OtlpKeyValueTransformer.Instance.TryTransformTag(attribute, out var result, attributeValueLengthLimit))
+                    else if (OtlpTagTransformer.Instance.TryTransformTag(attribute, out var result, attributeValueLengthLimit))
                     {
                         AddAttribute(otlpLogRecord, result, attributeCountLimit);
                     }
@@ -224,7 +224,7 @@ void ProcessScope(LogRecordScope scope, OtlpLogs.LogRecord otlpLog)
                     }
                     else
                     {
-                        if (OtlpKeyValueTransformer.Instance.TryTransformTag(scopeItem, out var result, attributeValueLengthLimit))
+                        if (OtlpTagTransformer.Instance.TryTransformTag(scopeItem, out var result, attributeValueLengthLimit))
                         {
                             AddAttribute(otlpLog, result, attributeCountLimit);
                         }
@@ -257,7 +257,7 @@ private static void AddAttribute(OtlpLogs.LogRecord logRecord, OtlpCommon.KeyVal
     private static void AddStringAttribute(OtlpLogs.LogRecord logRecord, string key, string value, int? maxValueLength, int maxAttributeCount)
     {
         var attributeItem = new KeyValuePair<string, object>(key, value);
-        if (OtlpKeyValueTransformer.Instance.TryTransformTag(attributeItem, out var result, maxValueLength))
+        if (OtlpTagTransformer.Instance.TryTransformTag(attributeItem, out var result, maxValueLength))
         {
             AddAttribute(logRecord, result, maxAttributeCount);
         }
@@ -267,7 +267,7 @@ private static void AddStringAttribute(OtlpLogs.LogRecord logRecord, string key,
     private static void AddIntAttribute(OtlpLogs.LogRecord logRecord, string key, int value, int maxAttributeCount)
     {
         var attributeItem = new KeyValuePair<string, object>(key, value);
-        if (OtlpKeyValueTransformer.Instance.TryTransformTag(attributeItem, out var result))
+        if (OtlpTagTransformer.Instance.TryTransformTag(attributeItem, out var result))
         {
             AddAttribute(logRecord, result, maxAttributeCount);
         }