Merge pull request #100 from nascimentod/feature/properties_column_predicate

Properties column predicate

Author: nblumhardt

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/ColumnOptions.cs

@@ -207,6 +207,11 @@ public PropertiesColumnOptions()
             ///     If true, will use the property key as the element name.
             /// </summary>
             public bool UsePropertyKeyAsElementName { get; set; }
+
+            /// <summary>
+            ///     If set, will only store properties allowed by the filter.
+            /// </summary>
+            public Predicate<string> PropertiesFilter { get; set; }
         }
 
         /// <summary>

src/Serilog.Sinks.MSSqlServer/Sinks/MSSqlServer/MSSqlServerSink.cs

@@ -303,6 +303,18 @@ private string ConvertPropertiesToXmlStructure(IEnumerable<KeyValuePair<string,
             if (options.ExcludeAdditionalProperties)
                 properties = properties.Where(p => !_additionalDataColumnNames.Contains(p.Key));
 
+            if (options.PropertiesFilter != null)
+            {
+                try
+                {
+                    properties = properties.Where(p => options.PropertiesFilter(p.Key));
+                }
+                catch (Exception ex)
+                {
+                    SelfLog.WriteLine("Unable to filter properties to store in {0} due to following error: {1}", this, ex);
+                }
+            }
+
             var sb = new StringBuilder();
 
             sb.AppendFormat("<{0}>", options.RootElementName);
@@ -414,7 +426,7 @@ protected override void Dispose(bool disposing)
             base.Dispose(disposing);
 
             if (_eventsTable != null)
-            { 
+            {
                 _eventsTable.Dispose();
                 _eventsTable = null;
             }

test/Serilog.Sinks.MSSqlServer.Tests/TestPropertiesColumnFiltering.cs

@@ -0,0 +1,51 @@
+using Dapper;
+using FluentAssertions;
+using System.Data.SqlClient;
+using Xunit;
+
+namespace Serilog.Sinks.MSSqlServer.Tests
+{
+    [Collection("LogTest")]
+    public class TestPropertiesColumnFiltering
+    {
+        internal class PropertiesColumns
+        {
+            public string Properties { get; set; }
+        }
+
+        [Fact]
+        public void FilteredProperties()
+        {
+            // arrange
+            var columnOptions = new ColumnOptions();
+            columnOptions.Properties.PropertiesFilter = (propName) => propName == "A";
+
+            Log.Logger = new LoggerConfiguration()
+                .WriteTo.MSSqlServer
+                (
+                    connectionString: DatabaseFixture.LogEventsConnectionString,
+                    tableName: DatabaseFixture.LogTableName,
+                    columnOptions: columnOptions,
+                    autoCreateSqlTable: true
+                )
+                .CreateLogger();
+
+            // act
+            Log.Logger
+                .ForContext("A", "AValue")
+                .ForContext("B", "BValue")
+                .Information("Logging message");
+
+            Log.CloseAndFlush();
+
+            // assert
+            using (var conn = new SqlConnection(DatabaseFixture.LogEventsConnectionString))
+            {
+                var logEvents = conn.Query<PropertiesColumns>($"SELECT Properties from {DatabaseFixture.LogTableName}");
+
+                logEvents.Should().Contain(e => e.Properties.Contains("AValue"));
+                logEvents.Should().NotContain(e => e.Properties.Contains("BValue"));
+            }
+        }
+    }
+}