* Updated all samples to use new SinkOptions based interface.

ckadluba · ckadluba · commit 060f3828f100 · 2020-04-19T02:03:56.000+02:00
* Fixed: TimeSpan parsing for System.Configuration SinkOptionsProvider plus tests
diff --git a/sample/AppConfigDemo/App.config b/sample/AppConfigDemo/App.config
@@ -7,13 +7,18 @@
     <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1" />
   </startup>
   <MSSqlServerSettingsSection>
+
+    <BatchPostingLimit Value="13" />
+    <BatchPeriod Value="00:00:15" />
+    
     <AddStandardColumns>
       <add Name="LogEvent" />
     </AddStandardColumns>
     <RemoveStandardColumns>
       <remove Name="Properties" />
     </RemoveStandardColumns>
     <TimeStamp ColumnName="TimeStampAlternative" ConvertToUtc="true" />
+
   </MSSqlServerSettingsSection>
   <runtime>
     <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
diff --git a/sample/AppConfigDemo/Program.cs b/sample/AppConfigDemo/Program.cs
@@ -3,6 +3,7 @@
 using Serilog;
 using Serilog.Events;
 using Serilog.Sinks.MSSqlServer;
+using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 namespace AppConfigDemo
 {
@@ -14,17 +15,34 @@ public static class Program
 
         public static void Main()
         {
+            // Legacy interace - do not use this anymore
+            //Log.Logger = new LoggerConfiguration().WriteTo
+            //    .MSSqlServer(
+            //        connectionString: _connectionString,
+            //        tableName: _tableName,
+            //        restrictedToMinimumLevel: LogEventLevel.Debug,
+            //        batchPostingLimit: MSSqlServerSink.DefaultBatchPostingLimit,
+            //        period: null,
+            //        formatProvider: null,
+            //        autoCreateSqlTable: true,
+            //        columnOptions: null,
+            //        schemaName: _schemaName,
+            //        logEventFormatter: null)
+            //    .CreateLogger();
+
+            // New SinkOptions based interface
             Log.Logger = new LoggerConfiguration().WriteTo
                 .MSSqlServer(
                     connectionString: _connectionString,
-                    tableName: _tableName,
+                    sinkOptions: new SinkOptions
+                    {
+                        TableName = _tableName,
+                        SchemaName = _schemaName,
+                        AutoCreateSqlTable = true
+                    },
                     restrictedToMinimumLevel: LogEventLevel.Debug,
-                    batchPostingLimit: MSSqlServerSink.DefaultBatchPostingLimit,
-                    period: null,
                     formatProvider: null,
-                    autoCreateSqlTable: true,
                     columnOptions: null,
-                    schemaName: _schemaName,
                     logEventFormatter: null)
                 .CreateLogger();
 
diff --git a/sample/CombinedConfigDemo/Program.cs b/sample/CombinedConfigDemo/Program.cs
@@ -2,6 +2,7 @@
 using System.Threading;
 using Microsoft.Extensions.Configuration;
 using Serilog;
+using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 namespace CombinedConfigDemo
 {
@@ -20,15 +21,32 @@ public static void Main()
                 .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                 .Build();
             var columnOptionsSection = configuration.GetSection("Serilog:ColumnOptions");
+            var sinkOptionsSection = configuration.GetSection("Serilog:SinkOptions");
 
+            // Legacy interace - do not use this anymore
+            //Log.Logger = new LoggerConfiguration()
+            //    .WriteTo.MSSqlServer(
+            //        connectionString: _connectionStringName,
+            //        tableName: _tableName,
+            //        appConfiguration: configuration,
+            //        autoCreateSqlTable: true,
+            //        columnOptionsSection: columnOptionsSection,
+            //        schemaName: _schemaName)
+            //    .CreateLogger();
+
+            // New SinkOptions based interface
             Log.Logger = new LoggerConfiguration()
                 .WriteTo.MSSqlServer(
                     connectionString: _connectionStringName,
-                    tableName: _tableName,
+                    sinkOptions: new SinkOptions
+                    {
+                        TableName = _tableName,
+                        SchemaName = _schemaName,
+                        AutoCreateSqlTable = true
+                    },
+                    sinkOptionsSection: sinkOptionsSection,
                     appConfiguration: configuration,
-                    autoCreateSqlTable: true,
-                    columnOptionsSection: columnOptionsSection,
-                    schemaName: _schemaName)
+                    columnOptionsSection: columnOptionsSection)
                 .CreateLogger();
 
             Log.Information("Hello {Name} from thread {ThreadId}", Environment.GetEnvironmentVariable("USERNAME"), Thread.CurrentThread.ManagedThreadId);
diff --git a/sample/CombinedConfigDemo/appsettings.json b/sample/CombinedConfigDemo/appsettings.json
@@ -10,6 +10,10 @@
     "LogDatabase": "Server=localhost;Database=LogTest;Integrated Security=SSPI;"
   },
   "Serilog": {
+    "SinkOptions": {
+      "batchPostingLimit": 5,
+      "batchPeriod": "00:00:15"
+    },
     "ColumnOptions": {
       "addStandardColumns": [ "LogEvent" ],
       "removeStandardColumns": [ "MessageTemplate", "Properties" ],
diff --git a/sample/CustomLogEventFormatterDemo/Program.cs b/sample/CustomLogEventFormatterDemo/Program.cs
@@ -2,6 +2,7 @@
 using System.Threading;
 using Serilog;
 using Serilog.Sinks.MSSqlServer;
+using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 namespace CustomLogEventFormatterDemo
 {
@@ -16,18 +17,37 @@ public static void Main()
             var options = new ColumnOptions();
             options.Store.Add(StandardColumn.LogEvent);
             var customFormatter = new FlatLogEventFormatter();
+
+            // Legacy interace - do not use this anymore
+            //Log.Logger = new LoggerConfiguration()
+            //    .WriteTo.MSSqlServer(_connectionString,
+            //        _tableName,
+            //        appConfiguration: null,
+            //        restrictedToMinimumLevel: Serilog.Events.LogEventLevel.Verbose,
+            //        batchPostingLimit: 50,
+            //        period: null,
+            //        formatProvider: null,
+            //        autoCreateSqlTable: true,
+            //        columnOptions: options,
+            //        columnOptionsSection: null,
+            //        schemaName: _schemaName,
+            //        logEventFormatter: customFormatter)
+            //    .CreateLogger();
+
+            // New SinkOptions based interface
             Log.Logger = new LoggerConfiguration()
                 .WriteTo.MSSqlServer(_connectionString,
-                    _tableName,
+                    sinkOptions: new SinkOptions
+                    {
+                        TableName = _tableName,
+                        SchemaName = _schemaName,
+                        AutoCreateSqlTable = true
+                    },
                     appConfiguration: null,
                     restrictedToMinimumLevel: Serilog.Events.LogEventLevel.Verbose,
-                    batchPostingLimit: 50,
-                    period: null,
                     formatProvider: null,
-                    autoCreateSqlTable: true,
                     columnOptions: options,
                     columnOptionsSection: null,
-                    schemaName: _schemaName,
                     logEventFormatter: customFormatter)
                 .CreateLogger();
 
diff --git a/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/SystemConfigurationSinkOptionsProvider.cs b/src/Serilog.Sinks.MSSqlServer/Configuration/Implementations/System.Configuration/SystemConfigurationSinkOptionsProvider.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Globalization;
 using Serilog.Configuration;
 using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
@@ -26,7 +27,7 @@ private void ReadTableOptions(MSSqlServerConfigurationSection config, SinkOption
         private void ReadBatchSettings(MSSqlServerConfigurationSection config, SinkOptions sinkOptions)
         {
             SetProperty.IfProvided<int>(config.BatchPostingLimit, nameof(config.BatchPostingLimit.Value), val => sinkOptions.BatchPostingLimit = val);
-            SetProperty.IfProvided<TimeSpan>(config.BatchPeriod, nameof(config.BatchPeriod.Value), val => sinkOptions.BatchPeriod = val);
+            SetProperty.IfProvided<string>(config.BatchPeriod, nameof(config.BatchPeriod.Value), val => sinkOptions.BatchPeriod = TimeSpan.Parse(val, CultureInfo.InvariantCulture));
         }
 
         private void ReadAzureManagedIdentitiesOptions(MSSqlServerConfigurationSection config, SinkOptions sinkOptions)
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/App.config b/test/Serilog.Sinks.MSSqlServer.Tests/App.config
@@ -34,6 +34,8 @@
   <SinkOptionsConfig>
     <TableName Value="LogEvents" />
     <AutoCreateSqlTable Value="true" />
+    <BatchPostingLimit Value="13" />
+    <BatchPeriod Value="00:00:15" />
   </SinkOptionsConfig>
 
 </configuration>
diff --git a/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Extensions/Hybrid/ConfigurationExtensionsTests.cs b/test/Serilog.Sinks.MSSqlServer.Tests/Configuration/Extensions/Hybrid/ConfigurationExtensionsTests.cs
@@ -136,7 +136,9 @@ private IConfiguration TestConfiguration() =>
                     { $"{_columnOptionsSection}:properties:columnName", "CustomProperties" },
 
                     { $"{_sinkOptionsSection}:tableName", DatabaseFixture.LogTableName },
-                    { $"{_sinkOptionsSection}:autoCreateSqlTable", "true" }
+                    { $"{_sinkOptionsSection}:autoCreateSqlTable", "true" },
+                    { $"{_sinkOptionsSection}:batchPostingLimit", "13" },
+                    { $"{_sinkOptionsSection}:batchPeriod", "00:00:15" }
                 })
                 .Build();
     }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Globalization;`
`2`	`3`	`using Serilog.Configuration;`
`3`	`4`	`using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;`
`4`	`5`
`@@ -26,7 +27,7 @@ private void ReadTableOptions(MSSqlServerConfigurationSection config, SinkOption`
`26`	`27`	`private void ReadBatchSettings(MSSqlServerConfigurationSection config, SinkOptions sinkOptions)`
`27`	`28`	`{`
`28`	`29`	`SetProperty.IfProvided<int>(config.BatchPostingLimit, nameof(config.BatchPostingLimit.Value), val => sinkOptions.BatchPostingLimit = val);`
`29`		`- SetProperty.IfProvided<TimeSpan>(config.BatchPeriod, nameof(config.BatchPeriod.Value), val => sinkOptions.BatchPeriod = val);`
	`30`	`+ SetProperty.IfProvided<string>(config.BatchPeriod, nameof(config.BatchPeriod.Value), val => sinkOptions.BatchPeriod = TimeSpan.Parse(val, CultureInfo.InvariantCulture));`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`private void ReadAzureManagedIdentitiesOptions(MSSqlServerConfigurationSection config, SinkOptions sinkOptions)`