Merge pull request serilog#160 from jonnybi/dev

added stringification support

Author: nblumhardt

src/Serilog.Extensions.Logging/Extensions/Logging/SerilogLogger.cs

@@ -78,6 +78,11 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
                         if (logger.BindProperty(property.Key.Substring(1), property.Value, true, out var destructured))
                             properties.Add(destructured);
                     }
+                    else if (property.Key.StartsWith("$"))
+                    {
+                        if (logger.BindProperty(property.Key.Substring(1), property.Value?.ToString(), true, out var stringified))
+                            properties.Add(stringified);
+                    }
                     else
                     {
                         if (logger.BindProperty(property.Key, property.Value, false, out var bound))

src/Serilog.Extensions.Logging/Extensions/Logging/SerilogLoggerScope.cs

@@ -71,14 +71,21 @@ public void EnrichAndCreateScopeItem(LogEvent logEvent, ILogEventPropertyFactory
 
                     var key = stateProperty.Key;
                     var destructureObject = false;
+                    var value = stateProperty.Value;
 
                     if (key.StartsWith("@"))
                     {
                         key = key.Substring(1);
                         destructureObject = true;
                     }
 
-                    var property = propertyFactory.CreateProperty(key, stateProperty.Value, destructureObject);
+                    if (key.StartsWith("$"))
+                    {
+                        key = key.Substring(1);
+                        value = value?.ToString();
+                    }
+
+                    var property = propertyFactory.CreateProperty(key, value, destructureObject);
                     logEvent.AddPropertyIfAbsent(property);
                 }
             }

test/Serilog.Extensions.Logging.Tests/SerilogLoggerTests.cs

@@ -162,6 +162,21 @@ public void SingleScopeProperty()
             Assert.Equal("\"pizza\"", sink.Writes[0].Properties["Name"].ToString());
         }
 
+        [Fact]
+        public void StringifyScopeProperty()
+        {
+            var (logger, sink) = SetUp(LogLevel.Trace);
+
+            using (logger.BeginScope("{$values}", new int[] { 1, 2, 3, 4 }))
+            {
+                logger.Log(LogLevel.Information, 0, TestMessage, null, null);
+            }
+
+            Assert.Equal(1, sink.Writes.Count);
+            Assert.True(sink.Writes[0].Properties.ContainsKey("values"));
+            Assert.Equal("\"System.Int32[]\"", sink.Writes[0].Properties["values"].ToString());
+        }
+
         [Fact]
         public void NestedScopeSameProperty()
         {
@@ -219,6 +234,24 @@ public void CarriesMessageTemplateProperties()
             Assert.Empty(selfLog.ToString());
         }
 
+        [Fact]
+        public void CarriesMessageTemplatePropertiesWhenStringificationIsUsed()
+        {
+            var selfLog = new StringWriter();
+            SelfLog.Enable(selfLog);
+            var (logger, sink) = SetUp(LogLevel.Trace);
+            var array = new[] { 1, 2, 3, 4 };
+
+            logger.LogInformation("{$array}", array);
+
+            Assert.True(sink.Writes[0].Properties.ContainsKey("array"));
+            Assert.Equal("\"System.Int32[]\"", sink.Writes[0].Properties["array"].ToString());
+            Assert.Equal("{$array}", sink.Writes[0].MessageTemplate.Text);
+
+            SelfLog.Disable();
+            Assert.Empty(selfLog.ToString());
+        }
+
         [Fact]
         public void CarriesEventIdIfNonzero()
         {