Merge pull request #18 from serilog/dev

2.1.0 Release

Author: nblumhardt

Diff for: Build.ps1

@@ -1,29 +1,51 @@
+echo "build: Build started"
+
 Push-Location $PSScriptRoot
 
-if(Test-Path .\artifacts) { Remove-Item .\artifacts -Force -Recurse }
+if(Test-Path .\artifacts) {
+	echo "build: Cleaning .\artifacts"
+	Remove-Item .\artifacts -Force -Recurse
+}
 
 & dotnet restore --no-cache
 
 $branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$env:APPVEYOR_REPO_BRANCH -ne $NULL];
 $revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:APPVEYOR_BUILD_NUMBER, 10); $false = "local" }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
-$suffix = @{ $true = ""; $false = "$branch-$revision"}[$branch -eq "master" -and $revision -ne "local"]
+$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "master" -and $revision -ne "local"]
 
-foreach ($src in ls src/Serilog.*) {
+echo "build: Version suffix is $suffix"
+
+foreach ($src in ls src/*) {
     Push-Location $src
 
-    & dotnet pack -c Release -o ..\..\.\artifacts --version-suffix=$suffix
+	echo "build: Packaging project in $src"
+
+    & dotnet pack -c Release -o ..\..\artifacts --version-suffix=$suffix
     if($LASTEXITCODE -ne 0) { exit 1 }    
 
     Pop-Location
 }
 
-foreach ($test in ls test/Serilog.*.Tests) {
+foreach ($test in ls test/*.PerformanceTests) {
     Push-Location $test
 
-    & dotnet test -c Release
+	echo "build: Building performance test project in $test"
+
+    & dotnet build -c Release
     if($LASTEXITCODE -ne 0) { exit 2 }
 
     Pop-Location
 }
 
+foreach ($test in ls test/*.Tests) {
+    Push-Location $test
+
+	echo "build: Testing project in $test"
+
+    & dotnet test -c Release
+    if($LASTEXITCODE -ne 0) { exit 3 }
+
+    Pop-Location
+}
+
 Pop-Location

Diff for: CHANGES.md

@@ -0,0 +1,7 @@
+2.1.0
+ * #14 - MinimumLevel.Override()
+ * #15 - Overload selection fix
+
+2.0.0
+ * Initial version
+ 

Diff for: README.md

@@ -21,7 +21,7 @@ Configuration is read from the `Serilog` section.
 }
 ```
 
-This example relies on the _Serilog.Sinks.Literate_, _Serilog.Sinks.File_, _Serilog.Enrichers.Environment_ and _Serilog.Sinks.Thread_ packages also being installed.
+This example relies on the _Serilog.Sinks.Literate_, _Serilog.Sinks.File_, _Serilog.Enrichers.Environment_ and _Serilog.Enrichers.Thread_ packages also being installed.
 
 After installing this package, use `ReadFrom.Configuration()` and pass an `IConfiguration` object.
 
@@ -64,3 +64,30 @@ To use this package in .NET 4.x applications, add `preserveCompilationContext` t
    }
 },
 ```
+
+### Level overrides
+
+The `MinimumLevel` configuration property can be set to a single value as in the sample above, or, levels can be overridden per logging source.
+
+This is useful in ASP.NET Core applications, which will often specify minimum level as:
+
+```json
+    "MinimumLevel": {
+        "Default": "Information",
+        "Override": {
+            "Microsoft": "Warning",
+            "System": "Warning"
+        }
+    }
+```
+
+### Environment variables
+
+If your application enables the environment variable configuration source (`AddEnvironmentVariables()`) you can add or override Serilog configuration through the environment.
+
+For example, to set the minimum log level using the _Windows_ command prompt:
+
+```
+set Serilog:MinimumLevel=Debug
+dotnet run
+```

Diff for: sample/Sample/Program.cs

@@ -4,6 +4,8 @@
 using Serilog;
 using System.IO;
 
+using Serilog.Core;
+
 namespace Sample
 {
     public class Program
@@ -21,7 +23,11 @@ public static void Main(string[] args)
 
             do
             {
-                logger.Information("Hello, world!");
+                logger.ForContext<Program>().Information("Hello, world!");
+                logger.ForContext(Constants.SourceContextPropertyName, "Microsoft").Warning("Hello, world!");
+                logger.ForContext(Constants.SourceContextPropertyName, "MyApp.Something.Tricky").Verbose("Hello, world!");
+
+                Console.WriteLine();
             }
             while (Console.ReadKey().KeyChar != 'q');
         }

Diff for: sample/Sample/appsettings.json

@@ -1,9 +1,20 @@
 {
   "Serilog": {
     "Using":  ["Serilog.Sinks.Literate"],
-    "MinimumLevel": "Debug",
+    "MinimumLevel": {
+      "Default": "Debug",
+      "Override": {
+        "Microsoft": "Warning",
+        "MyApp.Something.Tricky": "Verbose"
+      }
+    },
     "WriteTo": [
-      { "Name": "LiterateConsole" },
+      {
+        "Name": "LiterateConsole",
+        "Args": {
+          "outputTemplate": "[{Timestamp:HH:mm:ss} {SourceContext} [{Level}] {Message}{NewLine}{Exception}"
+        } 
+      },
       {        
         "Name": "File",
         "Args": {

Diff for: sample/Sample/project.lock.json

@@ -2349,13 +2349,12 @@
           "lib/netstandard1.3/_._": {}
         }
       },
-      "Serilog.Settings.Configuration/2.0.0-rc": {
+      "Serilog.Settings.Configuration/2.1.0": {
         "type": "project",
         "framework": ".NETStandard,Version=v1.6",
         "dependencies": {
           "Microsoft.Extensions.Configuration.Abstractions": "1.0.0",
           "Microsoft.Extensions.DependencyModel": "1.0.0",
-          "Newtonsoft.Json": "9.0.1",
           "Serilog": "2.0.0"
         },
         "compile": {
@@ -2673,13 +2672,12 @@
           "lib/net45/_._": {}
         }
       },
-      "Serilog.Settings.Configuration/2.0.0-rc": {
+      "Serilog.Settings.Configuration/2.1.0": {
         "type": "project",
         "framework": ".NETFramework,Version=v4.5.1",
         "dependencies": {
           "Microsoft.Extensions.Configuration.Abstractions": "1.0.0",
           "Microsoft.Extensions.DependencyModel": "1.0.0",
-          "Newtonsoft.Json": "9.0.1",
           "Serilog": "2.0.0",
           "System.Runtime": "4.0.10"
         },
@@ -7561,7 +7559,7 @@
         "ref/xamarinwatchos10/_._"
       ]
     },
-    "Serilog.Settings.Configuration/2.0.0-rc": {
+    "Serilog.Settings.Configuration/2.1.0": {
       "type": "project",
       "path": "../../src/Serilog.Settings.Configuration/project.json",
       "msbuildProject": "../../src/Serilog.Settings.Configuration/Serilog.Settings.Configuration.xproj"

Diff for: src/Serilog.Settings.Configuration/Settings/Configuration/ConfigurationReader.cs

@@ -80,8 +80,8 @@ Dictionary<string, Dictionary<string, string>> GetMethodCalls(IConfigurationSect
                 else
                 {
                     var name = child.GetSection("Name");
-                    if (name == null)
-                        throw new InvalidOperationException("The configuration value in Serilog.WriteTo has no Name element.");
+                    if (name.Value == null)
+                        throw new InvalidOperationException($"The configuration value in {name.Path} has no Name element.");
 
                     var callArgs = new Dictionary<string, string>();
                     var args = child.GetSection("Args");
@@ -100,25 +100,39 @@ Dictionary<string, Dictionary<string, string>> GetMethodCalls(IConfigurationSect
 
         void ApplyMinimumLevel(LoggerConfiguration loggerConfiguration)
         {
+            var applyMinimumLevelAction =
+                new Action<IConfigurationSection, Action<LoggerMinimumLevelConfiguration, LoggingLevelSwitch>>(
+                    (directive, applyConfigAction) =>
+                    {
+                        LogEventLevel minimumLevel;
+                        if (!Enum.TryParse(directive.Value, out minimumLevel))
+                            throw new InvalidOperationException($"The value {directive.Value} is not a valid Serilog level.");
+
+                        var levelSwitch = new LoggingLevelSwitch(minimumLevel);
+                        applyConfigAction(loggerConfiguration.MinimumLevel, levelSwitch);
+
+                        ChangeToken.OnChange(
+                            directive.GetReloadToken,
+                            () =>
+                            {
+                                if (Enum.TryParse(directive.Value, out minimumLevel))
+                                    levelSwitch.MinimumLevel = minimumLevel;
+                                else
+                                    SelfLog.WriteLine($"The value {directive.Value} is not a valid Serilog level.");
+                            });
+                    });
+
             var minimumLevelDirective = _configuration.GetSection("MinimumLevel");
-            if (minimumLevelDirective?.Value != null)
-            {
-                LogEventLevel minimumLevel;
-                if (!Enum.TryParse(minimumLevelDirective.Value, out minimumLevel))
-                    throw new InvalidOperationException($"The value {minimumLevelDirective.Value} is not a valid Serilog level.");
 
-                var levelSwitch = new LoggingLevelSwitch(minimumLevel);
-                loggerConfiguration.MinimumLevel.ControlledBy(levelSwitch);
+            var defaultMinLevelDirective = minimumLevelDirective.Value != null ? minimumLevelDirective : minimumLevelDirective.GetSection("Default");
+            if (defaultMinLevelDirective.Value != null)
+            {
+                applyMinimumLevelAction(defaultMinLevelDirective, (configuration, levelSwitch) => configuration.ControlledBy(levelSwitch));
+            }
 
-                ChangeToken.OnChange(
-                    () => minimumLevelDirective.GetReloadToken(),
-                    () =>
-                    {
-                        if (Enum.TryParse(minimumLevelDirective.Value, out minimumLevel))
-                            levelSwitch.MinimumLevel = minimumLevel;
-                        else
-                            SelfLog.WriteLine($"The value {minimumLevelDirective.Value} is not a valid Serilog level.");
-                    });
+            foreach (var overrideDirective in minimumLevelDirective.GetSection("Override").GetChildren())
+            {
+                applyMinimumLevelAction(overrideDirective, (configuration, levelSwitch) => configuration.Override(overrideDirective.Key, levelSwitch));
             }
         }
 
@@ -165,10 +179,7 @@ static void CallConfigurationMethods(Dictionary<string, Dictionary<string, strin
         {
             foreach (var method in methods)
             {
-                var methodInfo = configurationMethods
-                    .Where(m => m.Name == method.Key && m.GetParameters().Skip(1).All(p => p.HasDefaultValue || method.Value.Any(s => s.Key == p.Name)))
-                    .OrderByDescending(m => m.GetParameters().Length)
-                    .FirstOrDefault();
+                var methodInfo = SelectConfigurationMethod(configurationMethods, method.Key, method.Value);
 
                 if (methodInfo != null)
                 {
@@ -183,6 +194,15 @@ static void CallConfigurationMethods(Dictionary<string, Dictionary<string, strin
             }
         }
 
+        internal static MethodInfo SelectConfigurationMethod(IEnumerable<MethodInfo> candidateMethods, string name, Dictionary<string, string> suppliedArgumentValues)
+        {
+            return candidateMethods
+                .Where(m => m.Name == name &&
+                            m.GetParameters().Skip(1).All(p => p.HasDefaultValue || suppliedArgumentValues.Any(s => s.Key == p.Name)))
+                .OrderByDescending(m => m.GetParameters().Count(p => suppliedArgumentValues.Any(s => s.Key == p.Name)))
+                .FirstOrDefault();
+        }
+
         static readonly Dictionary<Type, Func<string, object>> ExtendedTypeConversions = new Dictionary<Type, Func<string, object>>
             {
                 { typeof(Uri), s => new Uri(s) },

Diff for: src/Serilog.Settings.Configuration/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.0-*",
+  "version": "2.1.0-*",
   "description": "Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.",
   "authors": [ "Serilog Contributors" ],
   "packOptions": {
@@ -9,7 +9,6 @@
     "iconUrl": "http://serilog.net/images/serilog-configuration-nuget.png"
   },
   "dependencies": {
-    "Newtonsoft.Json": "9.0.1",
     "Microsoft.Extensions.Configuration.Abstractions": "1.0.0",
     "Microsoft.Extensions.DependencyModel": "1.0.0",
     "Serilog": "2.0.0"

Diff for: src/Serilog.Settings.Configuration/project.lock.json

@@ -3037,7 +3037,6 @@
     "": [
       "Microsoft.Extensions.Configuration.Abstractions >= 1.0.0",
       "Microsoft.Extensions.DependencyModel >= 1.0.0",
-      "Newtonsoft.Json >= 9.0.1",
       "Serilog >= 2.0.0"
     ],
     ".NETFramework,Version=v4.5.1": [

Diff for: test/Serilog.Settings.Configuration.Tests/ConfigurationReaderTests.cs

@@ -0,0 +1,49 @@
+using System.Collections.Generic;
+using Serilog.Settings.Configuration;
+using Serilog.Formatting;
+using Serilog.Formatting.Json;
+using Xunit;
+using System.Reflection;
+using System.Linq;
+
+namespace Serilog.Settings.Configuration.Tests
+{
+    public class ConfigurationReaderTests
+    {
+        [Fact]
+        public void StringValuesConvertToDefaultInstancesIfTargetIsInterface()
+        {
+            var result = ConfigurationReader.ConvertToType("Serilog.Formatting.Json.JsonFormatter, Serilog", typeof(ITextFormatter));
+            Assert.IsType<JsonFormatter>(result);
+        }
+
+        [Fact]
+        public void CallableMethodsAreSelected()
+        {
+            var options = typeof(DummyLoggerConfigurationExtensions).GetTypeInfo().DeclaredMethods.ToList();
+            Assert.Equal(2, options.Count(mi => mi.Name == "DummyRollingFile"));
+            var suppliedArguments = new Dictionary<string, string>
+            {
+                {"pathFormat", "C:\\" }
+            };
+
+            var selected = ConfigurationReader.SelectConfigurationMethod(options, "DummyRollingFile", suppliedArguments);
+            Assert.Equal(typeof(string), selected.GetParameters()[1].ParameterType);
+        }
+
+        [Fact]
+        public void MethodsAreSelectedBasedOnCountOfMatchedArguments()
+        {
+            var options = typeof(DummyLoggerConfigurationExtensions).GetTypeInfo().DeclaredMethods.ToList();
+            Assert.Equal(2, options.Count(mi => mi.Name == "DummyRollingFile"));
+            var suppliedArguments = new Dictionary<string, string>()
+            {
+                { "pathFormat", "C:\\" },
+                { "formatter", "SomeFormatter, SomeAssembly" }
+            };
+
+            var selected = ConfigurationReader.SelectConfigurationMethod(options, "DummyRollingFile", suppliedArguments);
+            Assert.Equal(typeof(ITextFormatter), selected.GetParameters()[1].ParameterType);
+        }
+    }
+}

Diff for: test/Serilog.Settings.Configuration.Tests/DummyLoggerConfigurationExtensions.cs

@@ -0,0 +1,29 @@
+using System;
+using Serilog.Configuration;
+using Serilog.Events;
+using Serilog.Formatting;
+
+namespace Serilog.Settings.Configuration.Tests
+{
+    static class DummyLoggerConfigurationExtensions
+    {
+        public static LoggerConfiguration DummyRollingFile(
+            LoggerSinkConfiguration loggerSinkConfiguration,
+            string pathFormat,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
+            string outputTemplate = null,
+            IFormatProvider formatProvider = null)
+        {
+            return null;
+        }
+
+        public static LoggerConfiguration DummyRollingFile(
+            LoggerSinkConfiguration loggerSinkConfiguration,
+            ITextFormatter formatter,
+            string pathFormat,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum)
+        {
+            return null;
+        }
+    }
+}