Eris.Serilog.Formatting.Json 1.0.0

Eris.Serilog.Formatting.Json

Json formatter for Serilog based on the serilog-formatting-compact formatter

Differences with the compact logger

• Use the fullname for the properties e.g. @timestamp instead of @t, message instead of @mt. The names can be configured via the settings.
• Always log the log level, does not assume Information as default
• Render the properties camelCase in the json format
• Render the properties one time, normal or formatted instead of the @r
• Message can optionally be rendered, default is to use the message template and not render
• Properties can optionally be wrapped in a parent object, default does not wrap

Getting started

create logger with SerilogJsonFormatter

var logger = new LoggerConfiguration()
    .WriteTo.Console(new SerilogJsonFormatter())
    .CreateLogger();

Settings

pass the settings object to the formatter

var settings = new SerilogJsonFormatterSettings 
{
...
}

new SerilogJsonFormatter(settings);

Sample

see sample folder for the sample code

log messages

logger.Information("Hello, Foo");

{"@timestamp":"2023-02-12T15:21:51.1626151Z","level":"Information","message":"Hello, Foo"}

logger.Information("Hello, {Name}", user.Name);

{"@timestamp":"2023-02-12T15:21:51.1778631Z","level":"Information","message":"Hello, {Name}","name":"Foo"}

var user = new User("Foo", 22, new[] { 1, 2, 3 }, 0xffffff);
logger.Information("Hello, {@User}", user);

{"@timestamp":"2023-02-12T15:21:51.1812302Z","level":"Information","message":"Hello, {@User}","user":{"name":"Foo","age":22,"tags":[1,2,3],"color":16777215}}

logger.Information("Hello, Foo");

{"@timestamp":"2023-02-12T15:21:51.1626151Z","level":"Information","message":"Hello, Foo"}

logger.Error(new Exception("exception message", new Exception("inner exception message")), "error");

{"@timestamp":"2023-02-12T15:21:51.1876463Z","level":"Error","message":"error","exception":"System.Exception: exception message\r\n ---> System.Exception: inner exception message\r\n   --- End of inner exception stack trace ---"}

RenderMessage: true

logger.Information("Hello, Foo");

{"@timestamp":"2023-02-12T15:21:51.1891336Z","level":"Information","message":"Hello, \"Foo\"","name":"Foo"}

WrapProperties: true

logger.Information("Hello, Foo");

{"@timestamp":"2023-02-12T15:21:51.1884321Z","level":"Information","message":"Hello, {Name}","properties":{"name":"Foo"}}

Microsoft.Extensions.Logging.ILogger

var builder = Host.CreateDefaultBuilder(args);
builder.UseSerilog(logger);
var app = builder.Build();

var mlogger = app.Services.GetRequiredService<ILogger<User>>();

mlogger.LogInformation("Hello, Foo");

{"@timestamp":"2023-02-12T15:21:51.4978918Z","level":"Information","message":"Hello, Foo","sourceContext":"User"}

mlogger.LogInformation("Hello, {Name}", user.Name);

{"@timestamp":"2023-02-12T15:21:51.5016522Z","level":"Information","message":"Hello, {Name}","name":"Foo","sourceContext":"User"}

mlogger.LogInformation("Hello, {@User}", user);

{"@timestamp":"2023-02-12T15:21:51.5019571Z","level":"Information","message":"Hello, {@User}","user":{"name":"Foo","age":22,"tags":[1,2,3],"color":16777215},"sourceContext":"User"}

mlogger.LogInformation("Color: {Color:x}", user.Color);

{"@timestamp":"2023-02-12T15:21:51.5021091Z","level":"Information","message":"Color: {Color:x}","color":"ffffff","sourceContext":"User"}

mlogger.LogError(new Exception("exception message", new Exception("inner exception message")), "error");

{"@timestamp":"2023-02-12T15:21:51.5023791Z","level":"Error","message":"error","exception":"System.Exception: exception message\r\n ---> System.Exception: inner exception message\r\n   --- End of inner exception stack trace ---","sourceContext":"User"}

Benchmarks

SerilogJsonFormatter performs about the same as the CompactJsonFormatter

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.19044.2364 (21H2)
Intel Core i7-9850H CPU 2.60GHz, 1 CPU, 12 logical and 6 physical cores
.NET SDK=7.0.100
  [Host]     : .NET 7.0.0 (7.0.22.51805), X64 RyuJIT
  DefaultJob : .NET 7.0.0 (7.0.22.51805), X64 RyuJIT