Merge pull request #461 from serilog-mssql/dev

Release 6.2.0

Author: ckadluba

.github/workflows/pr-analysis-codeql.yml

@@ -10,7 +10,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  build-and-analyze:
+  build-and-codeql:
     runs-on: windows-latest
     permissions:
       actions: read

.github/workflows/pr-analysis-devskim.yml

@@ -10,7 +10,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  analyze:
+  devskim:
     runs-on: ubuntu-latest
     permissions:
       actions: read

.github/workflows/pr-analysis-infersharp.yml

@@ -0,0 +1,42 @@
+name: PR Analysis InferSharp
+
+on:
+  workflow_run:
+    workflows: [ "PR Validation" ]
+    types:
+      - completed
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  download-and-infersharp:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Download binaries artifact from PR Validation workflow
+        id: download-artifact
+        uses: dawidd6/action-download-artifact@v2
+        with:
+          workflow: pr-validation.yml
+          workflow_conclusion: success
+          name: bin-net6
+          path: bin-net6
+          branch: ${{ github.ref }}
+          check_artifacts: true
+          search_artifacts: true
+
+      - name: Run Infer#
+        uses: microsoft/[email protected]
+        id: runinfersharp
+        with:
+          binary-path: bin-net6
+
+      - name: Upload SARIF output to GitHub Security Center
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: infer-out/report.sarif

.github/workflows/pr-validation.yml

@@ -15,3 +15,15 @@ jobs:
 
       - name: Run build and tests
         run: ./Build.ps1
+
+      - name: Upload binaries artifact for InferSharp workflow
+        uses: actions/upload-artifact@v3
+        with:
+          name: bin-net6
+          path: src\Serilog.Sinks.MSSqlServer\bin\Release\net6.0
+
+      - name: Upload testresults artifact with code coverage file
+        uses: actions/upload-artifact@v3
+        with:
+          name: testresults
+          path: test\Serilog.Sinks.MSSqlServer.Tests\TestResults

Build.ps1

@@ -54,7 +54,7 @@ if ($SkipTests -eq $false) {
 
         echo "build: Testing project in $test"
 
-        & dotnet test -c Release
+        & dotnet test -c Release --collect "XPlat Code Coverage"
         if($LASTEXITCODE -ne 0) { exit 3 }
 
         Pop-Location

CHANGES.md

@@ -1,3 +1,9 @@
+# 6.2.0
+* Implemented #454: LoggingLevelSwitch support to allows log level manipulation at runtime.
+* Fixed issue #458: Error if enrich nullable int columns by null value
+* Added CodeQL code scanning
+* Generate code coverage file when running tests in Build.ps1
+
 # 6.1.0
 * Fixed issues #207, #435, #419 & #292: Resolve hierarchical property expressions for additional columns
 * Fixed issue #432: Write full exception info to SelfLog

Directory.Packages.props

@@ -16,6 +16,7 @@
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
     <PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="6.0.0" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
+    <PackageVersion Include="coverlet.collector" Version="3.2.0" />
     <PackageVersion Include="FluentAssertions" Version="6.7.0" />
     <PackageVersion Include="Dapper.StrongName" Version="2.0.123" />
     <PackageVersion Include="Moq" Version="4.18.2" />

README.md

@@ -60,7 +60,7 @@ All properties in the `MSSqlServerSinkOptions` object are discussed in the [MSSq
 
 Table configuration with the optional `ColumnOptions` object is a lengthy subject discussed in the [ColumnOptions Object](#columnoptions-object) topic and other related topics.
 
-Like other sinks, `restrictedToMinimumLevel` controls the `LogEventLevel` messages that are processed by this sink.
+Like other sinks, `restrictedToMinimumLevel` controls the `LogEventLevel` messages that are processed by this sink. This parameter is ignored if the property [LevelSwitch](#levelswitch) in the sink options is set.
 
 This is a "periodic batching sink." The sink will queue a certain number of log events before they're actually written to SQL Server as a bulk insert operation. There is also a timeout period so that the batch is always written even if it has not been filled. By default, the batch size is 50 rows and the timeout is 5 seconds. You can change these through by setting the `MSSqlServerSinkOptions.BatchPostingLimit` and `MSSqlServerSinkOptions.BatchPeriod` arguments.
 
@@ -244,6 +244,7 @@ Basic settings of the sink are configured using the properties in a `MSSqlServer
 * `BatchPostingLimit`
 * `BatchPeriod`
 * `EagerlyEmitFirstEvent`
+* `LevelSwitch`
 
 ### TableName
 
@@ -281,6 +282,9 @@ This setting is not used by the audit sink as it writes each event immediately a
 A Flag to eagerly write a batch to the database containing the first received event regardless of `BatchPostingLimit` or `BatchPeriod`. It defaults to `true`.
 This setting is not used by the audit sink as it writes each event immediately and not in a batched manner.
 
+### LevelSwitch
+
+A switch allowing the pass-through minimum level to be changed at runtime. If this is set, the parameter `restrictedToMinimumLevel` in the [sink configuration method](#sink-configuration) is ignored.
 
 ## ColumnOptions Object
 

sample/CombinedConfigDemo/Program.cs

@@ -49,7 +49,7 @@ public static void Main()
                     columnOptionsSection: columnOptionsSection)
                 .CreateLogger();
 
-            Log.Information("Hello {Name} from thread {ThreadId}", Environment.GetEnvironmentVariable("USERNAME"), Thread.CurrentThread.ManagedThreadId);
+            Log.Information("Hello {Name} from thread {ThreadId}", Environment.GetEnvironmentVariable("USERNAME"), Environment.CurrentManagedThreadId);
 
             Log.Warning("No coins remain at position {@Position}", new { Lat = 25, Long = 134 });
 

sample/CustomLogEventFormatterDemo/Program.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Threading;
 using Serilog;
+using Serilog.Core;
 using Serilog.Sinks.MSSqlServer;
 
 namespace CustomLogEventFormatterDemo
@@ -16,6 +17,7 @@ public static void Main()
             var options = new ColumnOptions();
             options.Store.Add(StandardColumn.LogEvent);
             var customFormatter = new FlatLogEventFormatter();
+            var levelSwitch = new LoggingLevelSwitch();
 
             // Legacy interace - do not use this anymore
             //Log.Logger = new LoggerConfiguration()
@@ -40,7 +42,8 @@ public static void Main()
                     {
                         TableName = _tableName,
                         SchemaName = _schemaName,
-                        AutoCreateSqlTable = true
+                        AutoCreateSqlTable = true,
+                        LevelSwitch = levelSwitch
                     },
                     appConfiguration: null,
                     restrictedToMinimumLevel: Serilog.Events.LogEventLevel.Verbose,
@@ -54,10 +57,12 @@ public static void Main()
             {
                 Log.Debug("Getting started");
 
-                Log.Information("Hello {Name} from thread {ThreadId}", Environment.GetEnvironmentVariable("USERNAME"), Thread.CurrentThread.ManagedThreadId);
+                Log.Information("Hello {Name} from thread {ThreadId}", Environment.GetEnvironmentVariable("USERNAME"), Environment.CurrentManagedThreadId);
 
                 Log.Warning("No coins remain at position {@Position}", new { Lat = 25, Long = 134 });
 
+                UseLevelSwitchToModifyLogLevelDuringRuntime(levelSwitch);
+
                 Fail();
             }
             catch (DivideByZeroException e)
@@ -68,6 +73,19 @@ public static void Main()
             Log.CloseAndFlush();
         }
 
+        private static void UseLevelSwitchToModifyLogLevelDuringRuntime(LoggingLevelSwitch levelSwitch)
+        {
+            levelSwitch.MinimumLevel = Serilog.Events.LogEventLevel.Error;
+
+            Log.Information("This should not be logged");
+
+            Log.Error("This should be logged");
+
+            levelSwitch.MinimumLevel = Serilog.Events.LogEventLevel.Information;
+
+            Log.Information("This should be logged again");
+        }
+
         private static void Fail()
         {
             throw new DivideByZeroException();