Merge pull request #276 from serilog/dev

Release 5.4.0

Author: ckadluba

CHANGES.md

@@ -1,3 +1,9 @@
+# 5.4.0
+* Added support for Azure Managed Identities for Resources authentication (thanks to @darrenschwarz for the contribution).
+* New interface using `SinkOptions` parameter. Marked old interfaces obsolete.
+* Implemented Enhancement #182: configurable property names for custom columns (thanks to  @rocknet for the contribution).
+* Lots of refactoring and new unit tests.
+
 # 5.3.0  
 Code quality release.
  * Added code analysis and editorconfig rules based on Microsoft standards.

README.md

@@ -12,8 +12,7 @@ artifacts:
 deploy:
 - provider: NuGet
   api_key:
-    secure: N59tiJECUYpip6tEn0xvdmDAEiP9SIzyLEFLpwiigm/8WhJvBNs13QxzT1/3/JW/
-  skip_symbols: true
+    secure: K3/810hkTO6rd2AEHVkUQAadjGmDREus9k96QHu6hxrA1/wRTuAJemHMKtVVgIvf
   on:
     branch: /^(master|dev)$/
 - provider: GitHub

appveyor.yml

@@ -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">

sample/AppConfigDemo/App.config

@@ -2,7 +2,7 @@
 using System.Threading;
 using Serilog;
 using Serilog.Events;
-using Serilog.Sinks.MSSqlServer;
+using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
 
 namespace AppConfigDemo
 {
@@ -14,17 +14,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();
 

sample/AppConfigDemo/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);

sample/CombinedConfigDemo/Program.cs

@@ -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" ],

sample/CombinedConfigDemo/appsettings.json

@@ -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();
 

sample/CustomLogEventFormatterDemo/Program.cs

@@ -21,7 +21,8 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
 
             while (!stoppingToken.IsCancellationRequested)
             {
-                _logger.LogInformation("Worker running at: {time}", DateTimeOffset.Now);
+                _logger.LogInformation("Worker running at: {time}. CustomProperty1: {CustomProperty1}",
+                    DateTimeOffset.Now, "Value");
                 await Task.Delay(1000, stoppingToken);
             }
 

sample/WorkerServiceDemo/Worker.cs

@@ -14,20 +14,62 @@
         "Name": "MSSqlServer",
         "Args": {
           "connectionString": "Server=localhost;Database=LogTest;Integrated Security=SSPI;",
-          "tableName": "LogEvents",
+          "sinkOptionsSection": {
+            "tableName": "LogEvents",
+            "autoCreateSqlTable": true,
+            "useAzureManagedIdentity": false,
+            "azureServiceTokenProviderResource": "https://database.windpws.net/"
+          },
+          "restrictedToMinimumLevel": "Information",
           "columnOptionsSection": {
             "addStandardColumns": [ "LogEvent" ],
             "removeStandardColumns": [ "MessageTemplate", "Properties" ],
             "timeStamp": {
               "columnName": "Timestamp",
               "convertToUtc": false
-            }
+            },
+            "additionalColumns": [
+              {
+                "columnName": "AdditionalColumn1",
+                "propertyName": "CustomProperty1",
+                "dataType": "12"
+              }
+            ]
           },
-          "autoCreateSqlTable": true,
-          "restrictedToMinimumLevel": "Information",
           "logEventFormatter": "WorkerServiceDemo.CustomLogEventFormatter::Formatter, WorkerServiceDemo"
         }
       }
+    ],
+    "AuditTo": [
+      {
+        "Name": "MSSqlServer",
+        "Args": {
+          "connectionString": "Server=localhost;Database=LogTest;Integrated Security=SSPI;",
+          "restrictedToMinimumLevel": "Information",
+          "logEventFormatter": "WorkerServiceDemo.CustomLogEventFormatter::Formatter, WorkerServiceDemo",
+          "sinkOptionsSection": {
+            "tableName": "LogEventsAudit",
+            "autoCreateSqlTable": true,
+            "useAzureManagedIdentity": false,
+            "azureServiceTokenProviderResource": "https://database.windpws.net/"
+          },
+          "columnOptionsSection": {
+            "addStandardColumns": [ "LogEvent" ],
+            "removeStandardColumns": [ "MessageTemplate", "Properties" ],
+            "timeStamp": {
+              "columnName": "Timestamp",
+              "convertToUtc": false
+            },
+            "additionalColumns": [
+              {
+                "columnName": "AdditionalColumn1",
+                "propertyName": "CustomProperty1",
+                "dataType": "12"
+              }
+            ]
+          }
+        }
+      }
     ]
   }
 }