Merge pull request #4454 from dotnet-maestro-bot/merge/release/8.0-to-main

[automated] Merge branch 'release/8.0' => 'main'

Author: RussKie

src/Libraries/Microsoft.Extensions.Telemetry/Logging/ExtendedLogger.cs

@@ -165,8 +165,13 @@ void HandleException(Exception exception, int indent)
 
             _ = sb.Append(exception.GetType());
             _ = sb.Append(": ");
-            _ = sb.AppendLine(exception.Message);
-            _ = sb.Append(indentStr);
+
+            if (config.IncludeExceptionMessageInStackTraces)
+            {
+                _ = sb.AppendLine(exception.Message);
+                _ = sb.Append(indentStr);
+            }
+
             _ = sb.Append(trace);
 
             if (exception is AggregateException aggregateException)

src/Libraries/Microsoft.Extensions.Telemetry/Logging/ExtendedLoggerFactory.cs

@@ -251,8 +251,14 @@ private LoggerInformation[] CreateLoggers(string categoryName)
     private LoggerConfig ComputeConfig(LoggerEnrichmentOptions? enrichmentOptions)
     {
         return enrichmentOptions == null
-            ? new(Array.Empty<KeyValuePair<string, object?>>(), Array.Empty<Action<IEnrichmentTagCollector>>(), false, false, 0, _redactorProvider)
-            : new(_staticTags, _enrichers, enrichmentOptions.CaptureStackTraces, enrichmentOptions.UseFileInfoForStackTraces, enrichmentOptions.MaxStackTraceLength, _redactorProvider);
+            ? new(Array.Empty<KeyValuePair<string, object?>>(), Array.Empty<Action<IEnrichmentTagCollector>>(), false, false, false, 0, _redactorProvider)
+            : new(_staticTags,
+                _enrichers,
+                enrichmentOptions.CaptureStackTraces,
+                enrichmentOptions.UseFileInfoForStackTraces,
+                enrichmentOptions.IncludeExceptionMessageInStackTraces,
+                enrichmentOptions.MaxStackTraceLength,
+                _redactorProvider);
     }
 
     private void UpdateStackTraceOptions(LoggerEnrichmentOptions enrichmentOptions) => Config = ComputeConfig(enrichmentOptions);

src/Libraries/Microsoft.Extensions.Telemetry/Logging/LoggerConfig.cs

@@ -16,6 +16,7 @@ public LoggerConfig(
         Action<IEnrichmentTagCollector>[] enrichers,
         bool captureStackTraces,
         bool useFileInfoForStackTraces,
+        bool includeExceptionMessagesInStackTraces,
         int maxStackTraceLength,
         Func<DataClassification, Redactor> getRedactor)
     {
@@ -24,13 +25,15 @@ public LoggerConfig(
         CaptureStackTraces = captureStackTraces;
         UseFileInfoForStackTraces = useFileInfoForStackTraces;
         MaxStackTraceLength = maxStackTraceLength;
+        IncludeExceptionMessageInStackTraces = includeExceptionMessagesInStackTraces;
         GetRedactor = getRedactor;
     }
 
     public KeyValuePair<string, object?>[] StaticTags { get; }
     public Action<IEnrichmentTagCollector>[] Enrichers { get; }
     public bool CaptureStackTraces { get; }
     public bool UseFileInfoForStackTraces { get; }
+    public bool IncludeExceptionMessageInStackTraces { get; }
     public int MaxStackTraceLength { get; }
     public Func<DataClassification, Redactor> GetRedactor { get; }
 }

src/Libraries/Microsoft.Extensions.Telemetry/Logging/LoggerEnrichmentOptions.cs

@@ -40,9 +40,24 @@ public class LoggerEnrichmentOptions
     /// <remarks>
     /// Reading available debugging files produces richer stack traces, but can cost a substantial amount of time
     /// to generate. As a result, this option should only be turned on in development scenarios, not for production use.
+    ///
+    /// This property has no effect if <see cref="CaptureStackTraces"/> is <see langword="false"/>.
+    /// 
+    /// This defaults to <see langword="false"/>.
     /// </remarks>
     public bool UseFileInfoForStackTraces { get; set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether to include exception messages in stack traces.
+    /// </summary>
+    /// <value>
+    /// This defaults to <see langword="false"/>.
+    /// </value>
+    /// <remarks>
+    /// This property has no effect if <see cref="CaptureStackTraces"/> is <see langword="false"/>.
+    /// </remarks>
+    public bool IncludeExceptionMessageInStackTraces { get; set; }
+
     /// <summary>
     /// Gets or sets the maximum stack trace length to emit for a given log record.
     /// </summary>
@@ -51,6 +66,8 @@ public class LoggerEnrichmentOptions
     /// </value>
     /// <remarks>
     /// When set to a value less than 2 KB or greater than 32 KB, an exception will be thrown.
+    ///
+    /// This property has no effect if <see cref="CaptureStackTraces"/> is <see langword="false"/>.
     /// </remarks>
     [Range(MinDefinedStackTraceLength, MaxDefinedStackTraceLength)]
     public int MaxStackTraceLength { get; set; } = DefaultStackTraceLength;

test/Libraries/Microsoft.Extensions.Telemetry.Tests/Logging/ExtendedLoggerTests.cs

@@ -371,8 +371,10 @@ public static void StringStateObject()
         Assert.Equal("PAYLOAD", snap[0].StructuredState!.GetValue("{OriginalFormat}"));
     }
 
-    [Fact]
-    public static void Exceptions()
+    [Theory]
+    [InlineData(true)]
+    [InlineData(false)]
+    public static void Exceptions(bool includeExceptionMessage)
     {
         const string Category = "C1";
 
@@ -382,6 +384,7 @@ public static void Exceptions()
             CaptureStackTraces = true,
             UseFileInfoForStackTraces = true,
             MaxStackTraceLength = 4096,
+            IncludeExceptionMessageInStackTraces = includeExceptionMessage,
         };
 
         using var lf = new ExtendedLoggerFactory(
@@ -401,7 +404,7 @@ public static void Exceptions()
             List<Exception> exceptions = [];
             try
             {
-                throw new ArgumentNullException("ARG1");
+                throw new ArgumentNullException("EM1", (Exception?)null);
             }
             catch (ArgumentNullException e)
             {
@@ -410,7 +413,7 @@ public static void Exceptions()
 
             try
             {
-                throw new ArgumentOutOfRangeException("ARG2");
+                throw new ArgumentOutOfRangeException("EM2", (Exception?)null);
             }
             catch (ArgumentOutOfRangeException e)
             {
@@ -419,14 +422,14 @@ public static void Exceptions()
 
             try
             {
-                throw new InvalidOperationException("Doing crazy things");
+                throw new InvalidOperationException("EM3");
             }
             catch (InvalidOperationException e)
             {
                 exceptions.Add(e);
             }
 
-            throw new AggregateException("Outer", exceptions);
+            throw new AggregateException("EM4", exceptions);
         }
         catch (AggregateException e)
         {
@@ -487,6 +490,21 @@ public static void Exceptions()
         Assert.Contains("ArgumentNullException", stackTrace);
         Assert.Contains("ArgumentOutOfRangeException", stackTrace);
         Assert.Contains("InvalidOperationException", stackTrace);
+
+        if (includeExceptionMessage)
+        {
+            Assert.Contains("EM1", stackTrace);
+            Assert.Contains("EM2", stackTrace);
+            Assert.Contains("EM3", stackTrace);
+            Assert.Contains("EM4", stackTrace);
+        }
+        else
+        {
+            Assert.DoesNotContain("EM1", stackTrace);
+            Assert.DoesNotContain("EM2", stackTrace);
+            Assert.DoesNotContain("EM3", stackTrace);
+            Assert.DoesNotContain("EM4", stackTrace);
+        }
     }
 
 #if false