Generate scope property by default

Author: nblumhardt

src/Serilog.Extensions.Logging/Extensions/Logging/SerilogLoggerProvider.cs

@@ -27,7 +27,7 @@ public class SerilogLoggerProvider : ILoggerProvider, ILogEventEnricher
         // May be null; if it is, Log.Logger will be lazily used
         readonly ILogger _logger;
         readonly Action _dispose;
-        readonly bool _includeNamedScopes;
+        readonly bool _ignoreNamedScopes;
 
         /// <summary>
         /// Construct a <see cref="SerilogLoggerProvider"/>.
@@ -61,10 +61,9 @@ public SerilogLoggerProvider(ILogger logger, bool dispose)
         /// </summary>
         /// <param name="logger">A Serilog logger to pipe events through; if null, the static <see cref="Log"/> class will be used.</param>
         /// <param name="dispose">If true, the provided logger or static log class will be disposed/closed when the provider is disposed.</param>
-        /// <param name="includeNamedScopes">Indicates whether a <code>Scope</code> property should be generated when
-        /// <see cref="Microsoft.Extensions.Logging.ILogger.BeginScope"/> is called with <see cref="string"/> arguments. The
-        /// default is false.</param>
-        public SerilogLoggerProvider(ILogger logger, bool dispose, bool includeNamedScopes)
+        /// <param name="ignoreNamedScopes">If true, no <code>Scope</code> property will be generated when
+        /// <see cref="Microsoft.Extensions.Logging.ILogger.BeginScope"/> is called with <see cref="string"/> arguments.</param>
+        public SerilogLoggerProvider(ILogger logger, bool dispose, bool ignoreNamedScopes)
         {
             if (logger != null)
                 _logger = logger.ForContext(new[] { this });
@@ -77,7 +76,7 @@ public SerilogLoggerProvider(ILogger logger, bool dispose, bool includeNamedScop
                     _dispose = Log.CloseAndFlush;
             }
 
-            _includeNamedScopes = includeNamedScopes;
+            _ignoreNamedScopes = ignoreNamedScopes;
         }
 
         /// <inheritdoc />
@@ -100,7 +99,7 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
                 scope.Enrich(logEvent, propertyFactory);
             }
 
-            if (_includeNamedScopes)
+            if (!_ignoreNamedScopes)
             {
                 List<ScalarValue> names = null;
                 for (var scope = CurrentScope; scope != null; scope = scope.Parent)

src/Serilog.Extensions.Logging/SerilogLoggerFactoryExtensions.cs

@@ -20,19 +20,19 @@ public static class SerilogLoggerFactoryExtensions
         /// <param name="dispose">When true, dispose <paramref name="logger"/> when the framework disposes the provider. If the
         /// logger is not specified but <paramref name="dispose"/> is true, the <see cref="Log.CloseAndFlush()"/> method will be
         /// called on the static <see cref="Log"/> class instead.</param>
-        /// <param name="includeNamedScopes">Indicates whether a <code>Scope</code> property should be generated when
+        /// <param name="ignoreNamedScopes">If true, no <code>Scope</code> property will be generated when
         /// <see cref="Microsoft.Extensions.Logging.ILogger.BeginScope"/> is called with <see cref="string"/> arguments. The
-        /// default is false.</param>
+        /// default is to generate the property.</param>
         /// <returns>The logger factory.</returns>
         public static ILoggerFactory AddSerilog(
             this ILoggerFactory factory,
             ILogger logger = null,
             bool dispose = false,
-            bool includeNamedScopes = false)
+            bool ignoreNamedScopes = false)
         {
             if (factory == null) throw new ArgumentNullException(nameof(factory));
 
-            factory.AddProvider(new SerilogLoggerProvider(logger, dispose, includeNamedScopes));
+            factory.AddProvider(new SerilogLoggerProvider(logger, dispose, ignoreNamedScopes));
 
             return factory;
         }

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

@@ -19,7 +19,7 @@ public class SerilogLoggerTest
         private const string Name = "test";
         private const string TestMessage = "This is a test";
 
-        private Tuple<SerilogLogger, SerilogSink> SetUp(LogLevel logLevel, bool includeNamedScopes = false)
+        private Tuple<SerilogLogger, SerilogSink> SetUp(LogLevel logLevel)
         {
             var sink = new SerilogSink();
 
@@ -28,7 +28,7 @@ private Tuple<SerilogLogger, SerilogSink> SetUp(LogLevel logLevel, bool includeN
 
             SetMinLevel(config, logLevel);
 
-            var provider = new SerilogLoggerProvider(config.CreateLogger(), false, includeNamedScopes);
+            var provider = new SerilogLoggerProvider(config.CreateLogger());
             var logger = (SerilogLogger)provider.CreateLogger(Name);
 
             return new Tuple<SerilogLogger, SerilogSink>(logger, sink);
@@ -365,9 +365,9 @@ public void BeginScopeDoesNotModifyKeyWhenDestructurerIsNotUsedInDictionary()
         }
 
         [Fact]
-        public void NamedScopesAreCapturedWhenRequested()
+        public void NamedScopesAreCaptured()
         {
-            var t = SetUp(LogLevel.Trace, includeNamedScopes: true);
+            var t = SetUp(LogLevel.Trace);
             var logger = t.Item1;
             var sink = t.Item2;