Merge pull request #41 from serilog/dev

4.0.0 Release
serilog · Jul 2, 2024 · e7885a1 · e7885a1
2 parents f066af2 + c0c1a8f
commit e7885a1
Show file tree

Hide file tree

Showing 20 changed files with 508 additions and 584 deletions.
diff --git a/Build.ps1 b/Build.ps1
@@ -1,10 +1,10 @@
-echo "build: Build started"
+Write-Output "build: Build started"
 
 Push-Location $PSScriptRoot
 
 if(Test-Path .\artifacts) {
-	echo "build: Cleaning .\artifacts"
-	Remove-Item .\artifacts -Force -Recurse
+	Write-Output "build: Cleaning ./artifacts"
+	Remove-Item ./artifacts -Force -Recurse
 }
 
 & dotnet restore --no-cache
@@ -18,31 +18,33 @@ $buildSuffix = @{ $true = "$($suffix)-$($commitHash)"; $false = "$($branch)-$($c
 echo "build: Package version suffix is $suffix"
 echo "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
+    & dotnet build -c Release --version-suffix=$buildSuffix -p:ContinuousIntegrationBuild=true
+    if($LASTEXITCODE -ne 0) { throw "Build failed" }
+
     if ($suffix) {
-        & dotnet pack -c Release --include-source -o ..\..\artifacts --version-suffix=$suffix --no-build
+        & dotnet pack -c Release -o ..\..\artifacts --version-suffix=$suffix --no-build
     } else {
-        & dotnet pack -c Release --include-source -o ..\..\artifacts --no-build
+        & dotnet pack -c Release -o ..\..\artifacts --no-build
     }
-    if($LASTEXITCODE -ne 0) { exit 1 }    
+    if($LASTEXITCODE -ne 0) { throw "Packaging failed" }
 
     Pop-Location
 }
 
-foreach ($test in ls test/*.Tests) {
+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 }
+    if($LASTEXITCODE -ne 0) { throw "Testing failed" }
 
     Pop-Location
 }
 
-Pop-Location
+Pop-Location
diff --git a/README.md b/README.md
@@ -7,49 +7,46 @@ This package reads (deserializes) JSON log files created by [Serilog.Formatting.
 Log events are written to a file using `CompactJsonFormatter`:
 
 ```csharp
-using (var fileLog = new LoggerConfiguration()
+await using var fileLog = new LoggerConfiguration()
     .WriteTo.File(new CompactJsonFormatter(), "log.clef")
-    .CreateLogger())
+    .CreateLogger();
+
+fileLog.Information("Hello, {@User}", new { Name = "nblumhardt", Id = 101 });
+fileLog.Information("Number {N:x8}", 42);
+fileLog.Warning("Tags are {Tags}", new[] { "test", "orange" });
+
+try
 {
-    fileLog.Information("Hello, {@User}", new { Name = "nblumhardt", Id = 101 });
-    fileLog.Information("Number {N:x8}", 42);
-    fileLog.Warning("Tags are {Tags}", new[] { "test", "orange" });
-
-    try
-    {
-        throw new DivideByZeroException();
-    }
-    catch(Exception ex)
-    {
-        fileLog.Error(ex, "Something failed");
-    }
+    throw new DivideByZeroException();
+}
+catch(Exception ex)
+{
+    fileLog.Error(ex, "Something failed");
 }
 ```
 
 This creates a log file with content similar to:
 
 ```json
-{"@t":"2016-10-12T04:46:58.0554314Z","@mt":"Hello, {@User}","User":{"Name":"nblumhardt","Id":101}}
-{"@t":"2016-10-12T04:46:58.0684369Z","@mt":"Number {N:x8}","@r":["0000002a"],"N":42}
-{"@t":"2016-10-12T04:46:58.0724384Z","@mt":"Tags are {Tags}","@l":"Warning","Tags":["test","orange"]}
-{"@t":"2016-10-12T04:46:58.0904378Z","@mt":"Something failed","@l":"Error", "@x":"System.DivideByZer...<snip>"}
+{"@t":"2024-10-12T04:46:58.0554314Z","@mt":"Hello, {@User}","User":{"Name":"nblumhardt","Id":101}}
+{"@t":"2024-10-12T04:46:58.0684369Z","@mt":"Number {N:x8}","@r":["0000002a"],"N":42}
+{"@t":"2024-10-12T04:46:58.0724384Z","@mt":"Tags are {Tags}","@l":"Warning","Tags":["test","orange"]}
+{"@t":"2024-10-12T04:46:58.0904378Z","@mt":"Something failed","@l":"Error", "@x":"System.DivideByZer...<snip>"}
 ```
 
 An instance of `LogEventReader` converts each line of the log file back into a `LogEvent`, which can be manipulated, rendered, or written through another Serilog sink:
 
 ```csharp
-using (var console = new LoggerConfiguration()
-    .WriteTo.LiterateConsole()
-    .CreateLogger())
-{
-    using (var clef = File.OpenText("log.clef"))
-    {
-        var reader = new LogEventReader(clef);
-        LogEvent evt;
-        while (reader.TryRead(out evt))
-            console.Write(evt);
-    }
-}
+await using var console = new LoggerConfiguration()
+    .WriteTo.Console()
+    .CreateLogger();
+
+await using var clef = File.OpenText("log.clef"))
+
+var reader = new LogEventReader(clef);
+
+while (reader.TryRead(out var evt))
+    console.Write(evt);
 ```
 
 Output from the logger:

diff --git a/appveyor.yml b/appveyor.yml
@@ -1,32 +1,22 @@
 version: '{build}'
 skip_tags: true
 image: Visual Studio 2022
-install:
-  - ps: mkdir -Force ".\build\" | Out-Null
 build_script:
-- ps: ./Build.ps1
-test: off
+  - pwsh: ./Build.ps1
 artifacts:
-- path: artifacts/Serilog.*.nupkg
-only_commits:
-  files:
-    - serilog-sinks-compact-reader.sln
-    - src/Serilog.Sinks.Compact.Reader/
-    - Build.ps1
-    - assets/
-    - test/Serilog.Formatting.Compact.Reader.Tests/
+  - path: artifacts/Serilog.*.nupkg
+  - path: artifacts/Serilog.*.snupkg
 deploy:
-- provider: NuGet
-  api_key:
-    secure: bg8cOj0trljnQUuVcpbplFOcgB/3xdCrtuuCzNf0e8Yq8IbpOiKIwow630Ox+pQR
-  skip_symbols: true
-  on:
-    branch: /^(main|dev)$/
-- provider: GitHub
-  auth_token:
-    secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
-  artifact: /Serilog.*\.nupkg/
-  tag: v$(appveyor_build_version)
-  on:
-    branch: main
-
+  - provider: NuGet
+    api_key:
+      secure: bg8cOj0trljnQUuVcpbplFOcgB/3xdCrtuuCzNf0e8Yq8IbpOiKIwow630Ox+pQR
+    skip_symbols: true
+    on:
+      branch: /^(main|dev)$/
+  - provider: GitHub
+    auth_token:
+      secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
+    artifact: /Serilog.*\.nupkg/
+    tag: v$(appveyor_build_version)
+    on:
+      branch: main
diff --git a/example/RoundTrip/Program.cs b/example/RoundTrip/Program.cs
@@ -4,44 +4,36 @@
 using System.IO;
 using Serilog.Formatting.Compact;
 
-namespace RoundTrip
-{
-    public class Program
-    {
-        public static void Main(string[] args)
-        {
-            using (var fileLog = new LoggerConfiguration()
-                .WriteTo.File(new CompactJsonFormatter(), "log.clef")
-                .CreateLogger())
-            {
-                fileLog.Information("Hello, {@User}", new { Name = "nblumhardt", Id = 101 });
-                fileLog.Information("Number {N:x8}", 42);
-                fileLog.Information("String {S}", "Yes");
-                fileLog.Warning("Tags are {Tags}", new[] { "test", "orange" });
 
-                try
-                {
-                    throw new DivideByZeroException();
-                }
-                catch(Exception ex)
-                {
-                    fileLog.Error(ex, "Something failed");
-                }
-            }
+await using (var fileLog = new LoggerConfiguration()
+    .WriteTo.File(new CompactJsonFormatter(), "log.clef")
+    .CreateLogger())
+{
+    fileLog.Information("Hello, {@User}", new { Name = "nblumhardt", Id = 101 });
+    fileLog.Information("Number {N:x8}", 42);
+    fileLog.Information("String {S}", "Yes");
+    fileLog.Warning("Tags are {Tags}", new[] { "test", "orange" });
 
-            using (var console = new LoggerConfiguration()
-                .WriteTo.Console()
-                .CreateLogger())
-            {
-                using (var clef = File.OpenText("log.clef"))
-                {
-                    var reader = new LogEventReader(clef);
-                    while (reader.TryRead(out var evt))
-                        console.Write(evt);
-                }
-            }
+    try
+    {
+        throw new DivideByZeroException();
+    }
+    catch(Exception ex)
+    {
+        fileLog.Error(ex, "Something failed");
+    }
+}
 
-            File.Delete("log.clef");
-        }
+await using (var console = new LoggerConfiguration()
+    .WriteTo.Console()
+    .CreateLogger())
+{
+    using (var clef = File.OpenText("log.clef"))
+    {
+        var reader = new LogEventReader(clef);
+        while (reader.TryRead(out var evt))
+            console.Write(evt);
     }
 }
+
+File.Delete("log.clef");
diff --git a/example/RoundTrip/Properties/AssemblyInfo.cs b/example/RoundTrip/Properties/AssemblyInfo.cs
diff --git a/example/RoundTrip/RoundTrip.csproj b/example/RoundTrip/RoundTrip.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <AssemblyName>RoundTrip</AssemblyName>
     <OutputType>Exe</OutputType>
     <PackageId>RoundTrip</PackageId>
@@ -15,9 +15,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Serilog.Sinks.File" Version="3.1.0" />
-    <PackageReference Include="Serilog.Sinks.Console" Version="3.0.1" />
-    <PackageReference Include="Serilog.Formatting.Compact" Version="1.0.0" />
+    <PackageReference Include="Serilog.Sinks.File" Version="6.0.0" />
+    <PackageReference Include="Serilog.Sinks.Console" Version="6.0.0" />
+    <PackageReference Include="Serilog.Formatting.Compact" Version="3.0.0" />
   </ItemGroup>
 
 </Project>
diff --git a/global.json b/global.json
diff --git a/serilog-formatting-compact-reader.sln b/serilog-formatting-compact-reader.sln
@@ -13,7 +13,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "global", "global", "{70BA4A
 		README.md = README.md
 		.gitattributes = .gitattributes
 		.gitignore = .gitignore
-		global.json = global.json
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "asset", "asset", "{71DD3779-3435-42D0-BA02-AEA04EE5B1E5}"

diff --git a/src/Serilog.Formatting.Compact.Reader/ClefFields.cs b/src/Serilog.Formatting.Compact.Reader/ClefFields.cs
@@ -12,44 +12,38 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
+namespace Serilog.Formatting.Compact.Reader;
 
-namespace Serilog.Formatting.Compact.Reader
+static class ClefFields
 {
-    static class ClefFields
+    public const string Timestamp = "@t";
+    public const string MessageTemplate = "@mt";
+    public const string Level = "@l";
+    public const string Exception = "@x";
+    public const string Renderings = "@r";
+    public const string EventId = "@i";
+    public const string Message = "@m";
+    public const string TraceId = "@tr";
+    public const string SpanId = "@sp";
+
+    public static readonly string[] All = [Timestamp, MessageTemplate, Level, Exception, Renderings, EventId, Message, TraceId, SpanId
+    ];
+
+    const string Prefix = "@";
+    const string EscapedInitialAt = "@@";
+
+    public static string Unescape(string name)
     {
-        public const string Timestamp = "@t";
-        public const string MessageTemplate = "@mt";
-        public const string Level = "@l";
-        public const string Exception = "@x";
-        public const string Renderings = "@r";
-        public const string EventId = "@i";
-        public const string Message = "@m";
-        public const string TraceId = "@tr";
-        public const string SpanId = "@sp";
+        if (name.StartsWith(EscapedInitialAt))
+            return name.Substring(1);
 
-        public static readonly string[] All = { Timestamp, MessageTemplate, Level, Exception, Renderings, EventId, Message, TraceId, SpanId };
-
-        const string Prefix = "@";
-        const string EscapedInitialAt = "@@";
-
-        public static string Unescape(string name)
-        {
-            if (name.StartsWith(EscapedInitialAt))
-                return name.Substring(1);
-
-            return name;
-        }
-
-        public static bool IsUnrecognized(string name)
-        {
-            return !name.StartsWith(EscapedInitialAt) &&
-                name.StartsWith(Prefix) &&
-                !All.Contains(name);
-        }
+        return name;
     }
 
-}
+    public static bool IsUnrecognized(string name)
+    {
+        return !name.StartsWith(EscapedInitialAt) &&
+               name.StartsWith(Prefix) &&
+               !All.Contains(name);
+    }
+}