将 Serilog 与 Microsoft.Extensions.Logging.ILogger 结合使用

Question

I've created a .NET Core 3.1 project using a Host, the IoC container with IServiceCollection and implemented logging allover the place using the ILogger<T> interface from Microsoft.Extensions.Logging . I now need to implement more advanced logging and decided to use Serilog.

I assumed that it would be a breeze to switch from .NET built-in loggers to Serilog. But to my surprise, Serilog is using it's own ILogger interface - bummer! So now I needed to update ALL places to use Serilog ILogger , or to implement Serilog with a .NET Core ILogger<T> interface.

My question is - is it really not possible to use Serilog with the ILogger interface in Microsoft.Extensions.Logging ? Would be so much smarter!

Answer 1

In the Serilog.Extensions.Logging assembly there is a extension method on IloggingBuilder called AddSerilog (it's in the Serilog namespace) that will allow you to use Serilog for logging. For example:

.NET Core 2.2 and earlier (using WebHost ):

WebHost.CreateDefaultBuilder(args)
    .ConfigureLogging(logging =>
    {
        logging.ClearProviders();
        logging.AddSerilog();
    });

.NET Core 3.1 and later (using generic Host for either web or console apps):

Host.CreateDefaultBuilder(args)
    .ConfigureWebHostDefaults(webBuilder => webBuilder.UseStartup<Startup>()})
    .UseSerilog();

Now the ILogger and ILogger<> implementation will call into Serilog.

Answer 2

For .NET 6 and later

using Serilog;

var builder = WebApplication.CreateBuilder(args);

builder.Host.UseSerilog((ctx, lc) => lc
    .WriteTo.Console()
    .ReadFrom.Configuration(ctx.Configuration));

Reference: Here

Answer 3

In addition to ways by using builder.host.UseSeriLog() extensions method. Here is more elegant way (we can use in external console or unit test ILogger without implementation of main project) .

1. Install Nuget Package Serilog.Extensions.Logging along with core package Serilog .
2. Initialize Logger Configuration like you already doing. For example a typical logging configuration would be write to Console would be like Log.Logger = new LoggerConfiguration).WriteTo.Console().CreateLogger() .
3. Use ILoggerFactory extension method AddSeriLog() like this ILoggerFactory factory = new LoggerFactory().AddSerilog(Log.Logger);
4. Simply return factory.CreateLogger<T>();

public static Microsoft.Extensions.Logging.ILogger LoggingInstance<T>()
{
  Serilog.Log.Logger = Serilog.Log.Logger ?? new LoggerConfiguration().WriteTo.(xxxxYourSinksxxxx).CreateLogger();
  ILoggerFactory factory = new LoggerFactory().AddSerilog(Log.Logger);            
  return factory.CreateLogger<T>();
}

Its usage be like

var logger = LoggingInstance<YourModel>();