Added support for ExcludeAdditionalProperties for LogEvent column. (#27)

Feature filterable log event properties via new option "ExcludeAdditionalProperties' located in the LogEvent column options.

Author: sorenandersen

CHANGES.md

@@ -1,3 +1,6 @@
+2.0.33
+ * Option added to exclude redundant properties from serialized JSON in column LogEvent. (https://github.com/serilog/serilog-sinks-mssqlserver/pull/27)
+
 2.0.32
  * Safe conversion of data types. Also included selflog for bulk operation errors. (https://github.com/serilog/serilog-sinks-mssqlserver/pull/4)
 

README.md

@@ -103,6 +103,8 @@ However, if the data is to stay in SQL Server, then the additional properties ma
 
 The log event JSON can be stored to the LogEvent column. This can be enabled with the `columnOptions.Store` parameter.
 
+Use the `columnOptions.LogEvent.ExcludeAdditionalProperties` parameter to exclude redundant properties from the JSON. This is analogue to excluding redundant items from XML in the Properties column.
+
 ### Options for serialization of the Properties column
 
 The serialization of the properties column can be controlled by setting values in the in the `columnOptions.Properties` parameter.

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

@@ -32,6 +32,8 @@ public ColumnOptions()
             };
 
             TimeStamp = new TimeStampColumnOptions();
+
+            LogEvent = new LogEventColumnOptions();
         }
 
         /// <summary>
@@ -77,6 +79,11 @@ public ICollection<StandardColumn> Store
         /// </summary>
         public TimeStampColumnOptions TimeStamp { get; private set; }
 
+        /// <summary>
+        ///     Options for the LogEvent column.
+        /// </summary>
+        public LogEventColumnOptions LogEvent { get; private set; }
+
         /// <summary>
         ///     Options for the Level column.
         /// </summary>
@@ -178,5 +185,16 @@ public class TimeStampColumnOptions
             /// </summary>
             public bool ConvertToUtc { get; set; }
         }
+
+        /// <summary>
+        ///     Options for the LogEvent column.
+        /// </summary>
+        public class LogEventColumnOptions
+        {
+            /// <summary>
+            ///     Exclude properties from the LogEvent column if they are being saved to additional columns.
+            /// </summary>
+            public bool ExcludeAdditionalProperties { get; set; }
+        }
     }
 }

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

@@ -357,6 +357,12 @@ private string ConvertPropertiesToXmlStructure(IEnumerable<KeyValuePair<string,
 
         private string LogEventToJson(LogEvent logEvent)
         {
+            if (_columnOptions.LogEvent.ExcludeAdditionalProperties)
+            {
+                var filteredProperties = logEvent.Properties.Where(p => !_additionalDataColumnNames.Contains(p.Key));
+                logEvent = new LogEvent(logEvent.Timestamp, logEvent.Level, logEvent.Exception, logEvent.MessageTemplate, filteredProperties.Select(x => new LogEventProperty(x.Key, x.Value)));
+            }
+
             var sb = new StringBuilder();
             using (var writer = new System.IO.StringWriter(sb))
                 _jsonFormatter.Format(logEvent, writer);