[AOT] Removed support for ParseStateValues if the state neither implements IReadOnlyList nor IEnumberable when ParseStateValues is true.

src/OpenTelemetry/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+* **Breaking Change** Removed support for parsing `TState` types passed to the
+  `ILogger.Log<TState>` API when `ParseStateValues` is true and `TState` does
+  not implement either `IReadOnlyList<KeyValuePair<string, object>>` or
+  `IEnumerable<KeyValuePair<string, object>>`. This was done to make logging AOT
+  compatible. This feature was first introduced in `1.5.0` stable release with
+  [#4334](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4334).
+  ([#4560](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4560))
+
 * Add back support for Exemplars. See [exemplars](../../docs/metrics/customizing-the-sdk/README.md#exemplars)
   for instructions to enable exemplars.
   ([#4553](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4553))

src/OpenTelemetry/Internal/OpenTelemetrySdkEventSource.cs

@@ -141,20 +141,20 @@ public void DroppedExportProcessorItems(string exportProcessorName, string expor
         }
 
         [NonEvent]
-        public void LoggerParseStateException<TState>(Exception exception)
+        public void LoggerProviderException(string methodName, Exception ex)
         {
-            if (this.IsEnabled(EventLevel.Warning, EventKeywords.All))
+            if (this.IsEnabled(EventLevel.Error, EventKeywords.All))
             {
-                this.LoggerParseStateException(typeof(TState).FullName!, exception.ToInvariantString());
+                this.LoggerProviderException(methodName, ex.ToInvariantString());
             }
         }
 
         [NonEvent]
-        public void LoggerProviderException(string methodName, Exception ex)
+        public void LoggerProcessStateSkipped<TState>()
         {
-            if (this.IsEnabled(EventLevel.Error, EventKeywords.All))
+            if (this.IsEnabled(EventLevel.Warning, EventKeywords.All))
             {
-                this.LoggerProviderException(methodName, ex.ToInvariantString());
+                this.LoggerProcessStateSkipped(typeof(TState).FullName!, "This can be fixed by updating the state to be a type that implements either IReadOnlyList<KeyValuePair<string, object>> or IEnumerable<KeyValuePair<string, object>>.");
             }
         }
 
@@ -301,12 +301,6 @@ public void InvalidEnvironmentVariable(string key, string? value)
             this.WriteEvent(47, key, value);
         }
 
-        [Event(48, Message = "Exception thrown parsing log state of type '{0}'. Exception: '{1}'", Level = EventLevel.Warning)]
-        public void LoggerParseStateException(string type, string error)
-        {
-            this.WriteEvent(48, type, error);
-        }
-
         [Event(49, Message = "LoggerProviderSdk event: '{0}'", Level = EventLevel.Verbose)]
         public void LoggerProviderSdkEvent(string message)
         {
@@ -319,6 +313,12 @@ public void LoggerProviderException(string methodName, string ex)
             this.WriteEvent(50, methodName, ex);
         }
 
+        [Event(51, Message = "Skip processing log state of type '{0}' because it does not implement either IReadOnlyList<KeyValuePair<string, object>> or IEnumerable<KeyValuePair<string, object>>. Suggested action: '{1}'.", Level = EventLevel.Warning)]
+        public void LoggerProcessStateSkipped(string type, string fix)
+        {
+            this.WriteEvent(51, type, fix);
+        }
+
 #if DEBUG
         public class OpenTelemetryEventListener : EventListener
         {

src/OpenTelemetry/Logs/ILogger/OpenTelemetryLogger.cs

@@ -16,7 +16,6 @@
 
 #nullable enable
 
-using System.ComponentModel;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
@@ -194,36 +193,8 @@ internal static void SetLogRecordSeverityFields(ref LogRecordData logRecordData,
         }
         else
         {
-            try
-            {
-                PropertyDescriptorCollection itemProperties = TypeDescriptor.GetProperties(state);
-
-                var attributeStorage = logRecord.AttributeStorage ??= new List<KeyValuePair<string, object?>>(itemProperties.Count);
-
-                foreach (PropertyDescriptor? itemProperty in itemProperties)
-                {
-                    if (itemProperty == null)
-                    {
-                        continue;
-                    }
-
-                    object? value = itemProperty.GetValue(state);
-                    if (value == null)
-                    {
-                        continue;
-                    }
-
-                    attributeStorage.Add(new KeyValuePair<string, object?>(itemProperty.Name, value));
-                }
-
-                return attributeStorage;
-            }
-            catch (Exception parseException)
-            {
-                OpenTelemetrySdkEventSource.Log.LoggerParseStateException<TState>(parseException);
-
-                return Array.Empty<KeyValuePair<string, object?>>();
-            }
+            OpenTelemetrySdkEventSource.Log.LoggerProcessStateSkipped<TState>();
+            return Array.Empty<KeyValuePair<string, object?>>();
         }
     }
 

test/OpenTelemetry.AotCompatibility.Tests/AotCompatibilityTests.cs

@@ -85,7 +85,7 @@ public void EnsureAotCompatibility()
             Assert.True(process.ExitCode == 0, "Publishing the AotCompatibility app failed. See test output for more details.");
 
             var warnings = expectedOutput.ToString().Split('\n', '\r').Where(line => line.Contains("warning IL"));
-            Assert.Equal(37, warnings.Count());
+            Assert.Equal(36, warnings.Count());
         }
     }
 }

test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpLogExporterTests.cs

@@ -101,7 +101,6 @@ public void AddOtlpLogExporterParseStateValueCanBeTurnedOff(bool parseState)
             {
                 Assert.Null(logRecord.State);
                 Assert.NotNull(logRecord.Attributes);
-                Assert.Contains(logRecord.Attributes, kvp => kvp.Key == "propertyA" && (string)kvp.Value == "valueA");
             }
             else
             {
@@ -141,7 +140,6 @@ public void AddOtlpLogExporterParseStateValueCanBeTurnedOffHosting(bool parseSta
             {
                 Assert.Null(logRecord.State);
                 Assert.NotNull(logRecord.Attributes);
-                Assert.Contains(logRecord.Attributes, kvp => kvp.Key == "propertyA" && (string)kvp.Value == "valueA");
             }
             else
             {

test/OpenTelemetry.Tests/Logs/LogRecordTest.cs

@@ -804,37 +804,6 @@ public void ParseStateValuesUsingIEnumerableTest()
             Assert.Equal(new KeyValuePair<string, object>("Key1", "Value1"), logRecord.StateValues[0]);
         }
 
-        [Fact]
-        public void ParseStateValuesUsingCustomTest()
-        {
-            using var loggerFactory = InitializeLoggerFactory(out List<LogRecord> exportedItems, configure: options => options.ParseStateValues = true);
-            var logger = loggerFactory.CreateLogger<LogRecordTest>();
-
-            // Tests unknown state parse path.
-
-            CustomState state = new CustomState
-            {
-                Property = "Value",
-            };
-
-            logger.Log(
-                LogLevel.Information,
-                0,
-                state,
-                null,
-                (s, e) => "OpenTelemetry!");
-            var logRecord = exportedItems[0];
-
-            Assert.Null(logRecord.State);
-            Assert.NotNull(logRecord.StateValues);
-            Assert.Equal(1, logRecord.StateValues.Count);
-
-            KeyValuePair<string, object> actualState = logRecord.StateValues[0];
-
-            Assert.Equal("Property", actualState.Key);
-            Assert.Equal("Value", actualState.Value);
-        }
-
         [Fact]
         public void DisposingStateTest()
         {