Merge pull request #82 from serilog/dev

4.0.0 Release

.travis.yml

@@ -3,9 +3,10 @@ language: csharp
 matrix:
   include:
     - os: linux # Ubuntu 14.04
-      dist: trusty
+      dist: xenial
       sudo: required
-      dotnet: 1.0.4
+      dotnet: 2.2.401
+      mono: none
       group: edge
 
 script:

Build.ps1

@@ -1,27 +1,30 @@
-echo "build: Build started"
+Write-Output "build: Build started"
+
+& dotnet --info
+& dotnet --list-sdks
 
 Push-Location $PSScriptRoot
 
 if(Test-Path .\artifacts) {
-	echo "build: Cleaning .\artifacts"
+    Write-Output "build: Cleaning .\artifacts"
 	Remove-Item .\artifacts -Force -Recurse
 }
 
 & dotnet restore --no-cache
 
 $branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$env:APPVEYOR_REPO_BRANCH -ne $NULL];
 $revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:APPVEYOR_BUILD_NUMBER, 10); $false = "local" }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
-$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "master" -and $revision -ne "local"]
+$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "main" -and $revision -ne "local"]
 $commitHash = $(git rev-parse --short HEAD)
 $buildSuffix = @{ $true = "$($suffix)-$($commitHash)"; $false = "$($branch)-$($commitHash)" }[$suffix -ne ""]
 
-echo "build: Package version suffix is $suffix"
-echo "build: Build version suffix is $buildSuffix" 
+Write-Output "build: Package version suffix is $suffix"
+Write-Output "build: Build version suffix is $buildSuffix" 
 
-foreach ($src in ls src/*) {
+foreach ($src in Get-ChildItem src/*) {
     Push-Location $src
 
-	echo "build: Packaging project in $src"
+    Write-Output "build: Packaging project in $src"
 
     & dotnet build -c Release --version-suffix=$buildSuffix
     if ($suffix) {
@@ -34,10 +37,21 @@ foreach ($src in ls src/*) {
     Pop-Location
 }
 
-foreach ($test in ls test/*.Tests) {
+foreach ($sample in Get-ChildItem sample/*) {
+    Push-Location $sample
+
+    Write-Output "build: Testing project in $sample"
+
+    & dotnet build -c Release --version-suffix=$buildSuffix
+    if($LASTEXITCODE -ne 0) { exit 3 }
+
+    Pop-Location
+}
+
+foreach ($test in Get-ChildItem test/*.Tests) {
     Push-Location $test
 
-	echo "build: Testing project in $test"
+	Write-Output "build: Testing project in $test"
 
     & dotnet test -c Release
     if($LASTEXITCODE -ne 0) { exit 3 }

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Code of Conduct
 
-Please refer to the [Serilog Code of Conduct](https://github.com/serilog/serilog/blob/dev/CONTRIBUTING.md) which covers all repositories within the Serilog Organisation.
+Please refer to the [Serilog Code of Conduct](https://github.com/serilog/serilog/blob/dev/CODE_OF_CONDUCT.md) which covers all repositories within the Serilog Organization.

README.md

@@ -6,8 +6,8 @@ A Serilog sink that writes log events to the Windows Console or an ANSI terminal
 
 To use the console sink, first install the [NuGet package](https://nuget.org/packages/serilog.sinks.console):
 
-```powershell
-Install-Package Serilog.Sinks.Console
+```shell
+dotnet add package Serilog.Sinks.Console
 ```
 
 Then enable the sink using `WriteTo.Console()`:
@@ -64,14 +64,14 @@ The default template, shown in the example above, uses built-in properties like
 
 The sink can write JSON  output instead of plain text. `CompactJsonFormatter` or `RenderedCompactJsonFormatter` from [Serilog.Formatting.Compact](https://github.com/serilog/serilog-formatting-compact) is recommended:
 
-```powershell
-Install-Package Serilog.Formatting.Compact
+```shell
+dotnet add package Serilog.Formatting.Compact
 ```
 
 Pass a formatter to the `Console()` configuration method:
 
 ```csharp
-    .WriteTo.Console(new CompactJsonFormatter())
+    .WriteTo.Console(new RenderedCompactJsonFormatter())
 ```
 
 Output theming is not available when custom formatters are used.
@@ -80,8 +80,8 @@ Output theming is not available when custom formatters are used.
 
 To use the console sink with the [Serilog.Settings.AppSettings](https://github.com/serilog/serilog-settings-appsettings) package, first install that package if you haven't already done so:
 
-```powershell
-Install-Package Serilog.Settings.AppSettings
+```shell
+dotnet add package Serilog.Settings.AppSettings
 ```
 
 Instead of configuring the logger in code, call `ReadFrom.AppSettings()`:
@@ -101,12 +101,21 @@ In your application's `App.config` or `Web.config` file, specify the console sin
     <add key="serilog:write-to:Console" />
 ```
 
+To configure the console sink with a different theme and include the `SourceContext` in the output, change your `App.config`/`Web.config` to:
+```xml
+<configuration>
+  <appSettings>
+    <add key="serilog:using:Console" value="Serilog.Sinks.Console" />
+    <add key="serilog:write-to:Console.theme" value="Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console" />
+    <add key="serilog:write-to:Console.outputTemplate" value="[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} &lt;s:{SourceContext}&gt;{NewLine}{Exception}" />
+```
+
 ### JSON `appsettings.json` configuration
 
 To use the console sink with _Microsoft.Extensions.Configuration_, for example with ASP.NET Core or .NET Core, use the [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) package. First install that package if you have not already done so:
 
-```powershell
-Install-Package Serilog.Settings.Configuration
+```shell
+dotnet add package Serilog.Settings.Configuration
 ```
 
 Instead of configuring the sink directly in code, call `ReadFrom.Configuration()`:
@@ -122,7 +131,6 @@ var logger = new LoggerConfiguration()
 ```
 
 In your `appsettings.json` file, under the `Serilog` node, :
-
 ```json
 {
   "Serilog": {
@@ -131,18 +139,23 @@ In your `appsettings.json` file, under the `Serilog` node, :
 }
 ```
 
-### Upgrading from _Serilog.Sinks.Console_ 2.x
-
-To achieve output identical to version 2 of this sink, specify a formatter and output template explicitly:
-
-```csharp
-    .WriteTo.Console(new MessageTemplateTextFormatter(
-        "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] {Message}{NewLine}{Exception}",
-        null))
+To configure the console sink with a different theme and include the `SourceContext` in the output, change your `appsettings.json` to:
+```json
+{
+  "Serilog": {
+    "WriteTo": [
+      {
+          "Name": "Console",
+          "Args": {
+            "theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
+            "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} <s:{SourceContext}>{NewLine}{Exception}"
+          }
+      }
+    ]
+  }
+}
 ```
 
-This will bypass theming and use Serilog's built-in message template formatting.
-
 ### Contributing
 
 Would you like to help make the Serilog console sink even better? We keep a list of issues that are approachable for newcomers under the [up-for-grabs](https://github.com/serilog/serilog-sinks-console/issues?labels=up-for-grabs&state=open) label. Before starting work on a pull request, we suggest commenting on, or raising, an issue on the issue tracker so that we can help and coordinate efforts.  For more details check out our [contributing guide](CONTRIBUTING.md).
@@ -155,7 +168,7 @@ When contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md).
 Branch  | AppVeyor | Travis
 ------------- | ------------- |-------------
 dev | [![Build status](https://ci.appveyor.com/api/projects/status/w1w3m1wyk3in1c96/branch/dev?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/dev)  | [![Build Status](https://travis-ci.org/serilog/serilog-sinks-console.svg?branch=dev)](https://travis-ci.org/serilog/serilog-sinks-console) 
-master | [![Build status](https://ci.appveyor.com/api/projects/status/w1w3m1wyk3in1c96/branch/master?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/master) | [![Build Status](https://travis-ci.org/serilog/serilog-sinks-console.svg?branch=master)](https://travis-ci.org/serilog/serilog-sinks-console) 
+main | [![Build status](https://ci.appveyor.com/api/projects/status/w1w3m1wyk3in1c96/branch/main?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/main) | [![Build Status](https://travis-ci.org/serilog/serilog-sinks-console.svg?branch=main)](https://travis-ci.org/serilog/serilog-sinks-console) 
 
 
-_Copyright &copy; 2017 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._
+_Copyright &copy; Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._

appveyor.yml

@@ -1,7 +1,6 @@
 version: '{build}'
 skip_tags: true
-image: Visual Studio 2017
-configuration: Release
+image: Visual Studio 2019
 test: off
 build_script:
 - ps: ./Build.ps1
@@ -10,14 +9,14 @@ artifacts:
 deploy:
 - provider: NuGet
   api_key:
-    secure: nvZ/z+pMS91b3kG4DgfES5AcmwwGoBYQxr9kp4XiJHj25SAlgdIxFx++1N0lFH2x
+    secure: rbdBqxBpLt4MkB+mrDOYNDOd8aVZ1zMkysaVNAXNKnC41FYifzX3l9LM8DCrUWU5
   skip_symbols: true
   on:
-    branch: /^(master|dev)$/
+    branch: /^(main|dev)$/
 - provider: GitHub
   auth_token:
     secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
   artifact: /Serilog.*\.nupkg/
   tag: v$(appveyor_build_version)
   on:
-    branch: master
+    branch: main

build.sh

@@ -5,15 +5,14 @@ dotnet --info
 dotnet restore
 
 for path in src/**/*.csproj; do
-    dotnet build -f netstandard1.3 -c Release ${path}
-    dotnet build -f netcoreapp1.1 -c Release ${path}
+    dotnet build -f netstandard2.0 -c Release ${path}
 done
 
 for path in test/*.Tests/*.csproj; do
-    dotnet test -f netcoreapp1.1  -c Release ${path}
+    dotnet test -f netcoreapp2.2 -c Release ${path}
 done
 
 for path in sample/ConsoleDemo/*.csproj; do
-    dotnet build -f netcoreapp1.1 -c Release ${path}
-    dotnet run -f netcoreapp1.1 --project ${path}
+    dotnet build -f netcoreapp2.2 -c Release ${path}
+    dotnet run -f netcoreapp2.2 --project ${path}
 done

sample/ConsoleDemo/ConsoleDemo.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFrameworks>netcoreapp1.1;net45</TargetFrameworks>
+    <TargetFrameworks>netcoreapp2.1;netcoreapp2.2;netcoreapp3.0;netcoreapp3.1;net452;net462;net472;net48;net5.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>

sample/ConsoleDemo/Program.cs

@@ -1,11 +1,11 @@
 using Serilog;
+using Serilog.Sinks.SystemConsole.Themes;
 using System;
 using System.Threading;
-using Serilog.Sinks.SystemConsole.Themes;
 
 namespace ConsoleDemo
 {
-    public class Program
+    public static class Program
     {
         public static void Main()
         {

sample/SyncWritesDemo/Program.cs

@@ -0,0 +1,57 @@
+using Serilog;
+using Serilog.Sinks.SystemConsole.Themes;
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace SyncWritesDemo
+{
+    public static class Program
+    {
+        public static void Main(string[] args)
+        {
+            Console.WriteLine("A sample of how to sync writes to the console sink.");
+
+            if (args != null && args.Length == 1)
+            {
+                switch (args[0])
+                {
+                    case "--sync-root-default":
+                        SystemConsoleSyncTest(syncRootForLogger1: null, syncRootForLogger2: null);
+                        return;
+                    case "--sync-root-separate":
+                        SystemConsoleSyncTest(syncRootForLogger1: new object(), syncRootForLogger2: new object());
+                        return;
+                    case "--sync-root-same":
+                        var sameSyncRoot = new object();
+                        SystemConsoleSyncTest(syncRootForLogger1: sameSyncRoot, syncRootForLogger2: sameSyncRoot);
+                        return;
+                }
+            }
+
+            Console.WriteLine("Expecting one of the following arguments:{0}--sync-root-default{0}--sync-root-separate{0}--sync-root-same", Environment.NewLine);
+        }
+
+        static void SystemConsoleSyncTest(object syncRootForLogger1, object syncRootForLogger2)
+        {
+            var logger1 = new LoggerConfiguration()
+                .MinimumLevel.Verbose()
+                .Enrich.WithProperty("Logger", "logger1")
+                .WriteTo.Console(theme: SystemConsoleTheme.Literate, syncRoot: syncRootForLogger1)
+                .CreateLogger();
+
+            var logger2 = new LoggerConfiguration()
+                .MinimumLevel.Verbose()
+                .Enrich.WithProperty("Logger", "logger2")
+                .WriteTo.Console(theme: SystemConsoleTheme.Literate, syncRoot: syncRootForLogger2)
+                .CreateLogger();
+
+            var options = new ParallelOptions { MaxDegreeOfParallelism = 8 };
+            Parallel.For(0, 1000, options, (i, loopState) =>
+            {
+                var logger = (i % 2 == 0) ? logger1 : logger2;
+                logger.Information("Event {Iteration} generated by {ThreadId}", i, Thread.CurrentThread.ManagedThreadId);
+            });
+        }
+    }
+}

sample/SyncWritesDemo/SyncWritesDemo.csproj

@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net5.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Serilog.Sinks.Console\Serilog.Sinks.Console.csproj" />
+  </ItemGroup>
+
+</Project>