Serilog.Formatting.Compact.Reader 4.0.1-dev-00081

Serilog.Formatting.Compact.Reader Build status NuGet Pre Release

This package reads (deserializes) JSON log files created by Serilog.Formatting.Compact back into Serilog LogEvents.

Example

Log events are written to a file using CompactJsonFormatter:

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.Warning("Tags are {Tags}", new[] { "test", "orange" });

try
{
    throw new DivideByZeroException();
}
catch(Exception ex)
{
    fileLog.Error(ex, "Something failed");
}

This creates a log file with content similar to:

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

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:

Screenshot

Limitations

Events deserialized from JSON are for typical purposes just like the original log events. There are two main things to keep in mind:

  1. JSON doesn't carry all of the type information necessary to determine if, for example, a number is an int or a float. JSON.NET does a good job of deserializing anything that it encounters, but you can't rely on the types here being identical.
  2. Exceptions deserialized this way aren't instances of the original exception type - all you can do with them is call ToString() to get the formatted message and stack trace, which is what 99% of Serilog sinks will do.

Showing the top 20 packages that depend on Serilog.Formatting.Compact.Reader.

Packages Downloads
UmbracoCms.Core
Contains the core assemblies needed to run Umbraco Cms. This package only contains assemblies and can be used for package development. Use the UmbracoCms package to setup Umbraco in Visual Studio as an ASP.NET project.
15
UmbracoCms.Core
Contains the core assemblies needed to run Umbraco Cms. This package only contains assemblies and can be used for package development. Use the UmbracoCms package to setup Umbraco in Visual Studio as an ASP.NET project.
16
UmbracoCms.Core
Contains the core assemblies needed to run Umbraco Cms. This package only contains assemblies and can be used for package development. Use the UmbracoCms package to setup Umbraco in Visual Studio as an ASP.NET project.
17

.NET Framework 4.6.2

.NET Framework 4.7.1

.NET 6.0

.NET 8.0

.NET Standard 2.0

Version Downloads Last updated
4.1.0-dev-00085 11 23.08.2025
4.1.0-dev-00082 11 23.08.2025
4.0.1-dev-00081 11 23.08.2025
4.0.1-dev-00079 11 23.08.2025
4.0.0 12 23.08.2025
4.0.0-dev-00071 11 23.08.2025
3.0.0 12 23.08.2025
3.0.0-dev-00063 11 23.08.2025
2.0.0 13 23.08.2025
2.0.0-dev-00060 11 23.08.2025
1.0.6-dev-00059 11 23.08.2025
1.0.5 12 23.08.2025
1.0.5-dev-00048 12 23.08.2025
1.0.4 12 23.08.2025
1.0.3 12 23.08.2025
1.0.3-dev-00036 11 23.08.2025
1.0.3-dev-00034 11 23.08.2025
1.0.3-dev-00033 11 23.08.2025
1.0.2 11 23.08.2025
1.0.2-dev-00024 11 23.08.2025
1.0.2-dev-00020 11 23.08.2025
1.0.1 11 23.08.2025
1.0.1-dev-00016 11 23.08.2025
1.0.1-dev-00014 11 23.08.2025
1.0.0 12 23.08.2025
1.0.0-dev-00010 12 23.08.2025
1.0.0-dev-00008 11 23.08.2025
1.0.0-dev-00006 11 23.08.2025
1.0.0-dev-00004 11 23.08.2025
1.0.0-dev-00002 11 23.08.2025
1.0.0-dev-00001 11 23.08.2025