Merge pull request #326 from serilog/dev

Release 5.6.0

Author: ckadluba

CHANGES.md

@@ -1,3 +1,9 @@
+# 5.6.0
+* Fixed issue #191: Added option `EagerlyEmitFirstEvent` by implementing new PeriodicBatchingSink API.
+* Replaced `SinkOptions` with `MSSqlServerSinkOptions` and cleaned up namespaced (thanks to @jonorossi for the contribution).
+* Target .NET Core 2.1 (LTS) instead of 2.2
+* Fixed issue #312: Data conversion issue causes logging to silently fail.
+
 # 5.5.1
 * Fixed issue #300 Support DateTime2 data type for TimeStamp column (thanks to @stedel for the contribution).
 * Added Sourcelink support and publish symbols to nuget.org which allows consumers of the package to debug into the sink code.

README.md

@@ -5,23 +5,23 @@ configuration: Release
 install:
   - ps: mkdir -Force ".\build\" | Out-Null
 build_script:
-- ps: ./Build.ps1
+  - ps: ./Build.ps1
 test: off
 artifacts:
-- path: artifacts/Serilog.*.nupkg
-- path: artifacts/Serilog.*.snupkg
+  - path: artifacts/Serilog.*.nupkg
+  - path: artifacts/Serilog.*.snupkg
 deploy:
-- provider: NuGet
-  api_key:
-    secure: K3/810hkTO6rd2AEHVkUQAadjGmDREus9k96QHu6hxrA1/wRTuAJemHMKtVVgIvf
-  on:
-    branch: /^(master|dev)$/
-- provider: GitHub
-  auth_token:
-    secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
-  artifacts:
-    /Serilog.*\.nupkg/
-    /Serilog.*\.snupkg/
-  tag: v$(appveyor_build_version)
-  on:
-    branch: master
+  - provider: NuGet
+    api_key:
+      secure: K3/810hkTO6rd2AEHVkUQAadjGmDREus9k96QHu6hxrA1/wRTuAJemHMKtVVgIvf
+    on:
+      branch: /^(master|dev)$/
+  - provider: GitHub
+    auth_token:
+      secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
+    artifacts:
+      /Serilog.*\.nupkg/
+      /Serilog.*\.snupkg/
+    tag: v$(appveyor_build_version)
+    on:
+      branch: master

appveyor.yml

@@ -10,6 +10,7 @@
 
     <BatchPostingLimit Value="13" />
     <BatchPeriod Value="00:00:15" />
+    <EagerlyEmitFirstEvent Value="true" />
 
     <AddStandardColumns>
       <add Name="LogEvent" />

sample/AppConfigDemo/App.config

@@ -2,7 +2,7 @@
 using System.Threading;
 using Serilog;
 using Serilog.Events;
-using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
+using Serilog.Sinks.MSSqlServer;
 
 namespace AppConfigDemo
 {
@@ -29,11 +29,11 @@ public static void Main()
             //        logEventFormatter: null)
             //    .CreateLogger();
 
-            // New SinkOptions based interface
+            // New MSSqlServerSinkOptions based interface
             Log.Logger = new LoggerConfiguration().WriteTo
                 .MSSqlServer(
                     connectionString: _connectionString,
-                    sinkOptions: new SinkOptions
+                    sinkOptions: new MSSqlServerSinkOptions
                     {
                         TableName = _tableName,
                         SchemaName = _schemaName,

sample/AppConfigDemo/Program.cs

@@ -2,7 +2,7 @@
 using System.Threading;
 using Microsoft.Extensions.Configuration;
 using Serilog;
-using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
+using Serilog.Sinks.MSSqlServer;
 
 namespace CombinedConfigDemo
 {
@@ -38,7 +38,7 @@ public static void Main()
             Log.Logger = new LoggerConfiguration()
                 .WriteTo.MSSqlServer(
                     connectionString: _connectionStringName,
-                    sinkOptions: new SinkOptions
+                    sinkOptions: new MSSqlServerSinkOptions
                     {
                         TableName = _tableName,
                         SchemaName = _schemaName,

sample/CombinedConfigDemo/Program.cs

@@ -12,7 +12,8 @@
   "Serilog": {
     "SinkOptions": {
       "batchPostingLimit": 5,
-      "batchPeriod": "00:00:15"
+      "batchPeriod": "00:00:15",
+      "eagerlyEmitFirstEvent": true
     },
     "ColumnOptions": {
       "addStandardColumns": [ "LogEvent" ],

sample/CombinedConfigDemo/appsettings.json

@@ -2,7 +2,6 @@
 using System.Threading;
 using Serilog;
 using Serilog.Sinks.MSSqlServer;
-using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 namespace CustomLogEventFormatterDemo
 {
@@ -34,10 +33,10 @@ public static void Main()
             //        logEventFormatter: customFormatter)
             //    .CreateLogger();
 
-            // New SinkOptions based interface
+            // New MSSqlServerSinkOptions based interface
             Log.Logger = new LoggerConfiguration()
                 .WriteTo.MSSqlServer(_connectionString,
-                    sinkOptions: new SinkOptions
+                    sinkOptions: new MSSqlServerSinkOptions
                     {
                         TableName = _tableName,
                         SchemaName = _schemaName,

sample/CustomLogEventFormatterDemo/Program.cs

@@ -3,7 +3,6 @@
 using Serilog;
 using Serilog.Events;
 using Serilog.Sinks.MSSqlServer;
-using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 namespace NetStandardDemoLib
 {
@@ -18,7 +17,7 @@ public static LoggerConfiguration CreateLoggerConfiguration()
                 .Enrich.FromLogContext()
                 .WriteTo.MSSqlServer(
                     _connectionString,
-                    new SinkOptions
+                    new MSSqlServerSinkOptions
                     {
                         TableName = _tableName,
                         AutoCreateSqlTable = true

sample/NetStandardDemo/NetStandardDemoLib/Initializer.cs

@@ -20,7 +20,6 @@
 using Serilog.Formatting;
 using Serilog.Sinks.MSSqlServer;
 using Serilog.Sinks.MSSqlServer.Configuration.Factories;
-using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 // The "Hybrid" configuration system supports both Microsoft.Extensions.Configuration and System.Configuration.
 // This is necessary because .NET Framework 4.6.1+ and .NET Core 2.0+ apps support both approaches, whereas the
@@ -44,7 +43,7 @@ public static class LoggerConfigurationMSSqlServerExtensions
         /// https://gist.github.com/mivano/10429656
         /// or use the autoCreateSqlTable option.
         ///
-        /// Note: this is the legacy version of the extension method. Please use the new one using SinkOptions instead.
+        /// Note: this is the legacy version of the extension method. Please use the new one using MSSqlServerSinkOptions instead.
         /// 
         /// </summary>
         /// <param name="loggerConfiguration">The logger configuration.</param>
@@ -62,7 +61,7 @@ public static class LoggerConfigurationMSSqlServerExtensions
         /// <param name="logEventFormatter">Supplies custom formatter for the LogEvent column, or null</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
-        [Obsolete("Use the new interface accepting a SinkOptions parameter instead. This will be removed in a future release.", error: false)]
+        [Obsolete("Use the new interface accepting a MSSqlServerSinkOptions parameter instead. This will be removed in a future release.", error: false)]
         public static LoggerConfiguration MSSqlServer(
             this LoggerSinkConfiguration loggerConfiguration,
             string connectionString,
@@ -79,9 +78,9 @@ public static LoggerConfiguration MSSqlServer(
             ITextFormatter logEventFormatter = null)
         {
             // Do not add new parameters here. This interface is considered legacy and will be deprecated in the future.
-            // For adding new input parameters use the SinkOptions class and the method overload that accepts SinkOptions.
+            // For adding new input parameters use the MSSqlServerSinkOptions class and the method overload that accepts MSSqlServerSinkOptions.
 
-            var sinkOptions = new SinkOptions(tableName, batchPostingLimit, period, autoCreateSqlTable, schemaName);
+            var sinkOptions = new MSSqlServerSinkOptions(tableName, batchPostingLimit, period, autoCreateSqlTable, schemaName);
 
             return loggerConfiguration.MSSqlServer(
                 connectionString: connectionString,
@@ -116,7 +115,7 @@ public static LoggerConfiguration MSSqlServer(
         public static LoggerConfiguration MSSqlServer(
             this LoggerSinkConfiguration loggerConfiguration,
             string connectionString,
-            SinkOptions sinkOptions = null,
+            MSSqlServerSinkOptions sinkOptions = null,
             IConfigurationSection sinkOptionsSection = null,
             IConfiguration appConfiguration = null,
             LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
@@ -136,23 +135,25 @@ public static LoggerConfiguration MSSqlServer(
                 logEventFormatter: logEventFormatter,
                 applySystemConfiguration: new ApplySystemConfiguration(),
                 applyMicrosoftExtensionsConfiguration: new ApplyMicrosoftExtensionsConfiguration(),
-                sinkFactory: new MSSqlServerSinkFactory());
+                sinkFactory: new MSSqlServerSinkFactory(),
+                batchingSinkFactory: new PeriodicBatchingSinkFactory());
 
         // Internal overload with parameters used by tests to override the config section and inject mocks
         internal static LoggerConfiguration MSSqlServerInternal(
             this LoggerSinkConfiguration loggerConfiguration,
             string connectionString,
-            SinkOptions sinkOptions = null,
-            IConfigurationSection sinkOptionsSection = null,
-            IConfiguration appConfiguration = null,
-            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
-            IFormatProvider formatProvider = null,
-            ColumnOptions columnOptions = null,
-            IConfigurationSection columnOptionsSection = null,
-            ITextFormatter logEventFormatter = null,
-            IApplySystemConfiguration applySystemConfiguration = null,
-            IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration = null,
-            IMSSqlServerSinkFactory sinkFactory = null)
+            MSSqlServerSinkOptions sinkOptions,
+            IConfigurationSection sinkOptionsSection,
+            IConfiguration appConfiguration,
+            LogEventLevel restrictedToMinimumLevel,
+            IFormatProvider formatProvider,
+            ColumnOptions columnOptions,
+            IConfigurationSection columnOptionsSection,
+            ITextFormatter logEventFormatter,
+            IApplySystemConfiguration applySystemConfiguration,
+            IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration,
+            IMSSqlServerSinkFactory sinkFactory,
+            IPeriodicBatchingSinkFactory batchingSinkFactory)
         {
             if (loggerConfiguration == null)
                 throw new ArgumentNullException(nameof(loggerConfiguration));
@@ -162,13 +163,15 @@ internal static LoggerConfiguration MSSqlServerInternal(
 
             var sink = sinkFactory.Create(connectionString, sinkOptions, formatProvider, columnOptions, logEventFormatter);
 
-            return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
+            var periodicBatchingSink = batchingSinkFactory.Create(sink, sinkOptions);
+
+            return loggerConfiguration.Sink(periodicBatchingSink, restrictedToMinimumLevel);
         }
 
         /// <summary>
         /// Adds a sink that writes log events to a table in a MSSqlServer database.
         ///
-        /// Note: this is the legacy version of the extension method. Please use the new one using SinkOptions instead.
+        /// Note: this is the legacy version of the extension method. Please use the new one using MSSqlServerSinkOptions instead.
         /// 
         /// </summary>
         /// <param name="loggerAuditSinkConfiguration">The logger configuration.</param>
@@ -184,7 +187,7 @@ internal static LoggerConfiguration MSSqlServerInternal(
         /// <param name="logEventFormatter">Supplies custom formatter for the LogEvent column, or null</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
-        [Obsolete("Use the new interface accepting a SinkOptions parameter instead. This will be removed in a future release.", error: false)]
+        [Obsolete("Use the new interface accepting a MSSqlServerSinkOptions parameter instead. This will be removed in a future release.", error: false)]
         public static LoggerConfiguration MSSqlServer(
             this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
             string connectionString,
@@ -199,9 +202,9 @@ public static LoggerConfiguration MSSqlServer(
             ITextFormatter logEventFormatter = null)
         {
             // Do not add new parameters here. This interface is considered legacy and will be deprecated in the future.
-            // For adding new input parameters use the SinkOptions class and the method overload that accepts SinkOptions.
+            // For adding new input parameters use the MSSqlServerSinkOptions class and the method overload that accepts MSSqlServerSinkOptions.
 
-            var sinkOptions = new SinkOptions(tableName, null, null, autoCreateSqlTable, schemaName);
+            var sinkOptions = new MSSqlServerSinkOptions(tableName, null, null, autoCreateSqlTable, schemaName);
 
             return loggerAuditSinkConfiguration.MSSqlServer(
                 connectionString: connectionString,
@@ -233,7 +236,7 @@ public static LoggerConfiguration MSSqlServer(
         public static LoggerConfiguration MSSqlServer(
             this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
             string connectionString,
-            SinkOptions sinkOptions = null,
+            MSSqlServerSinkOptions sinkOptions = null,
             IConfigurationSection sinkOptionsSection = null,
             IConfiguration appConfiguration = null,
             LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
@@ -259,17 +262,17 @@ public static LoggerConfiguration MSSqlServer(
         internal static LoggerConfiguration MSSqlServerInternal(
             this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
             string connectionString,
-            SinkOptions sinkOptions = null,
-            IConfigurationSection sinkOptionsSection = null,
-            IConfiguration appConfiguration = null,
-            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
-            IFormatProvider formatProvider = null,
-            ColumnOptions columnOptions = null,
-            IConfigurationSection columnOptionsSection = null,
-            ITextFormatter logEventFormatter = null,
-            IApplySystemConfiguration applySystemConfiguration = null,
-            IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration = null,
-            IMSSqlServerAuditSinkFactory auditSinkFactory = null)
+            MSSqlServerSinkOptions sinkOptions,
+            IConfigurationSection sinkOptionsSection,
+            IConfiguration appConfiguration,
+            LogEventLevel restrictedToMinimumLevel,
+            IFormatProvider formatProvider,
+            ColumnOptions columnOptions,
+            IConfigurationSection columnOptionsSection,
+            ITextFormatter logEventFormatter,
+            IApplySystemConfiguration applySystemConfiguration,
+            IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration,
+            IMSSqlServerAuditSinkFactory auditSinkFactory)
         {
             if (loggerAuditSinkConfiguration == null)
                 throw new ArgumentNullException(nameof(loggerAuditSinkConfiguration));
@@ -284,15 +287,15 @@ internal static LoggerConfiguration MSSqlServerInternal(
 
         private static void ReadConfiguration(
             ref string connectionString,
-            ref SinkOptions sinkOptions,
+            ref MSSqlServerSinkOptions sinkOptions,
             IConfigurationSection sinkOptionsSection,
             IConfiguration appConfiguration,
             ref ColumnOptions columnOptions,
             IConfigurationSection columnOptionsSection,
             IApplySystemConfiguration applySystemConfiguration,
             IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration)
         {
-            sinkOptions = sinkOptions ?? new SinkOptions();
+            sinkOptions = sinkOptions ?? new MSSqlServerSinkOptions();
             columnOptions = columnOptions ?? new ColumnOptions();
 
             var serviceConfigSection = applySystemConfiguration.GetSinkConfigurationSection(AppConfigSectionName);