PR feedback, and added IDestructuringPolicy to sample program and README

Author: MV10

README.md

@@ -15,6 +15,7 @@ Configuration is read from the `Serilog` section.
     ],
     "Enrich": ["FromLogContext", "WithMachineName", "WithThreadId"],
     "Destructure": [
+      { "Name": "With", "Args": { "policy": "Sample.CustomPolicy, Sample" } },
       { "Name": "ToMaximumDepth", "Args": { "maximumDestructuringDepth": 4 } },
       { "Name": "ToMaximumStringLength", "Args": { "maximumStringLength": 100 } },
       { "Name": "ToMaximumCollectionCount", "Args": { "maximumCollectionCount": 10 } }

sample/Sample/Program.cs

@@ -6,6 +6,7 @@
 using System.Linq;
 using Serilog.Core;
 using Serilog.Events;
+using System.Collections.Generic;
 
 namespace Sample
 {
@@ -41,9 +42,12 @@ public static void Main(string[] args)
                 logger.Information("Destructure with max collection count:\n{@BigData}",
                     new { TenItems = new string[] { "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten" } });
 
+                logger.Information("Destructure with policy to strip password:\n{@LoginData}",
+                    new LoginData { Username = "BGates", Password = "isityearoflinuxyet" });
+
                 Console.WriteLine("\nPress \"q\" to quit, or any other key to run again.\n");
             }
-            while (!args.Contains("--run-once") && (Console.ReadKey().KeyChar != 'q'));
+            while(!args.Contains("--run-once") && (Console.ReadKey().KeyChar != 'q'));
         }
     }
 
@@ -56,4 +60,29 @@ public bool IsEnabled(LogEvent logEvent)
             return true;
         }
     }
+
+    public class LoginData
+    {
+        public string Username;
+        public string Password;
+    }
+
+    public class CustomPolicy : IDestructuringPolicy
+    {
+        public bool TryDestructure(object value, ILogEventPropertyValueFactory propertyValueFactory, out LogEventPropertyValue result)
+        {
+            result = null;
+
+            if(value is LoginData)
+            {
+                result = new StructureValue(
+                    new List<LogEventProperty>
+                    {
+                        new LogEventProperty("Username", new ScalarValue(((LoginData)value).Username))
+                    });
+            }
+
+            return (result != null);
+        }
+    }
 }

sample/Sample/appsettings.json

@@ -44,6 +44,10 @@
       "Application": "Sample"
     },
     "Destructure": [
+      {
+        "Name": "With",
+        "Args": { "policy": "Sample.CustomPolicy, Sample" }
+      },
       {
         "Name": "ToMaximumDepth",
         "Args": { "maximumDestructuringDepth": 3 }

src/Serilog.Settings.Configuration/Settings/Configuration/ConfigurationReader.cs

@@ -350,7 +350,7 @@ internal static MethodInfo SelectConfigurationMethod(IEnumerable<MethodInfo> can
 
         internal static IList<MethodInfo> FindSinkConfigurationMethods(IReadOnlyCollection<Assembly> configurationAssemblies)
         {
-            var found = FindConfigurationExtensions(configurationAssemblies, typeof(LoggerSinkConfiguration));
+            var found = FindConfigurationExtensionMethods(configurationAssemblies, typeof(LoggerSinkConfiguration));
             if (configurationAssemblies.Contains(typeof(LoggerSinkConfiguration).GetTypeInfo().Assembly))
                 found.Add(GetSurrogateConfigurationMethod<LoggerSinkConfiguration, Action<LoggerConfiguration>, LoggingLevelSwitch>((c, a, s) => Logger(c, a, LevelAlias.Minimum, s)));
 
@@ -359,14 +359,14 @@ internal static IList<MethodInfo> FindSinkConfigurationMethods(IReadOnlyCollecti
 
         internal static IList<MethodInfo> FindAuditSinkConfigurationMethods(IReadOnlyCollection<Assembly> configurationAssemblies)
         {
-            var found = FindConfigurationExtensions(configurationAssemblies, typeof(LoggerAuditSinkConfiguration));
+            var found = FindConfigurationExtensionMethods(configurationAssemblies, typeof(LoggerAuditSinkConfiguration));
 
             return found;
         }
 
         internal static IList<MethodInfo> FindFilterConfigurationMethods(IReadOnlyCollection<Assembly> configurationAssemblies)
         {
-            var found = FindConfigurationExtensions(configurationAssemblies, typeof(LoggerFilterConfiguration));
+            var found = FindConfigurationExtensionMethods(configurationAssemblies, typeof(LoggerFilterConfiguration));
             if (configurationAssemblies.Contains(typeof(LoggerFilterConfiguration).GetTypeInfo().Assembly))
                 found.Add(GetSurrogateConfigurationMethod<LoggerFilterConfiguration, ILogEventFilter, object>((c, f, _) => With(c, f)));
 
@@ -375,7 +375,7 @@ internal static IList<MethodInfo> FindFilterConfigurationMethods(IReadOnlyCollec
 
         internal static IList<MethodInfo> FindDestructureConfigurationMethods(IReadOnlyCollection<Assembly> configurationAssemblies)
         {
-            var found = FindConfigurationExtensions(configurationAssemblies, typeof(LoggerDestructuringConfiguration));
+            var found = FindConfigurationExtensionMethods(configurationAssemblies, typeof(LoggerDestructuringConfiguration));
             if(configurationAssemblies.Contains(typeof(LoggerDestructuringConfiguration).GetTypeInfo().Assembly))
             {
                 found.Add(GetSurrogateConfigurationMethod<LoggerDestructuringConfiguration, IDestructuringPolicy, object>((c, d, _) => With(c, d)));
@@ -389,14 +389,14 @@ internal static IList<MethodInfo> FindDestructureConfigurationMethods(IReadOnlyC
 
         internal static IList<MethodInfo> FindEventEnricherConfigurationMethods(IReadOnlyCollection<Assembly> configurationAssemblies)
         {
-            var found = FindConfigurationExtensions(configurationAssemblies, typeof(LoggerEnrichmentConfiguration));
+            var found = FindConfigurationExtensionMethods(configurationAssemblies, typeof(LoggerEnrichmentConfiguration));
             if (configurationAssemblies.Contains(typeof(LoggerEnrichmentConfiguration).GetTypeInfo().Assembly))
                 found.Add(GetSurrogateConfigurationMethod<LoggerEnrichmentConfiguration, object, object>((c, _, __) => FromLogContext(c)));
 
             return found;
         }
 
-        internal static IList<MethodInfo> FindConfigurationExtensions(IReadOnlyCollection<Assembly> configurationAssemblies, Type configType)
+        internal static IList<MethodInfo> FindConfigurationExtensionMethods(IReadOnlyCollection<Assembly> configurationAssemblies, Type configType)
         {
             return configurationAssemblies
                 .SelectMany(a => a.ExportedTypes