Merge pull request #1357 from rob-earwaker/docs/default-destructuring…

…-depth Update summary for default destructuring depth
serilog · Aug 31, 2019 · 5c127cb · 5c127cb
2 parents f4c8798 + 0494601
commit 5c127cb
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/src/Serilog/Configuration/LoggerDestructuringConfiguration.cs b/src/Serilog/Configuration/LoggerDestructuringConfiguration.cs
@@ -137,9 +137,9 @@ public LoggerConfiguration ByTransforming<TValue>(Func<TValue, object> transform
         }
 
         /// <summary>
-        /// When destructuring objects, depth will be limited to 5 property traversals deep to
+        /// When destructuring objects, depth will be limited to 10 property traversals deep to
         /// guard against ballooning space when recursive/cyclic structures are accidentally passed. To
-        /// increase this limit pass a higher value.
+        /// change this limit pass a new maximum depth.
         /// </summary>
         /// <param name="maximumDestructuringDepth">The maximum depth to use.</param>
         /// <returns>Configuration object allowing method chaining.</returns>

diff --git a/test/Serilog.Tests/LoggerConfigurationTests.cs b/test/Serilog.Tests/LoggerConfigurationTests.cs
@@ -262,6 +262,35 @@ public void EnrichersExecuteInConfigurationOrder()
             Assert.True(enrichedPropertySeen);
         }
 
+        [Fact]
+        public void MaximumDestructuringDepthDefaultIsEffective()
+        {
+            var x = new
+            {
+                Lvl01 = new
+                {
+                    Lvl02 = new
+                    {
+                        Lvl03 = new
+                        {
+                            Lvl04 = new
+                            {
+                                Lvl05 = new
+                                {
+                                    Lvl06 = new { Lvl07 = new { Lvl08 = new { Lvl09 = new { Lvl10 = "Lvl11" } } } }
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+
+            var xs = LogAndGetAsString(x, conf => conf, "@");
+
+            Assert.Contains("Lvl10", xs);
+            Assert.DoesNotContain("Lvl11", xs);
+        }
+
         [Fact]
         public void MaximumDestructuringDepthIsEffective()
         {