How to dependency inject Serilog into the rest of my classes in .NET Console App

Question

I'm getting started with Serilog but I don't know how to dependency inject the ILogger into my classes. It's easy if I was using ASP.NET Core 5, but I'm using a .NET Core Console App. How can I do similarly?

Before with log4net:

public class TestStrategy
{
    private static readonly ILog _logger = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType.Name);

    ...
}

My Serilog logger creation:

var configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

var logger = new LoggerConfiguration()
    .ReadFrom.Configuration(configuration)
    .CreateLogger();

Do I have to DI logger into all classes?

You need to use a dependency injection framework. ASP.NET Core just happens to have a built-in system — Xerillio
– Xerillio, Commented Feb 21, 2021 at 16:41
Exactly. So you need add a DI framework to your project (CastleWindsor, Ninject, Spring.NET, Autofac...) — Xerillio
– Xerillio, Commented Feb 21, 2021 at 16:48
@Xerillio, Autofac seems to be the most used, but I gotta learn how to do it rn — nop
– nop, Commented Feb 21, 2021 at 17:13
This isn't really a Serilog question. There are lots of Q&As about how to add DI to a console app. — Kevin Krumwiede
– Kevin Krumwiede, Commented Feb 21, 2021 at 17:21

Melchia · Accepted Answer · 2021-02-21 19:20:09Z

Here's an example using .net 5 using Microsoft.Extensions.DependencyInjection;:

Program.cs:

namespace dotnet.console.app
{
    using System.Threading.Tasks;
    using Microsoft.Extensions.DependencyInjection;
    using Microsoft.Extensions.Hosting;
    using Serilog;
    class Program
    {
        static Task Main(string[] args) =>
            CreateHostBuilder(args).Build().RunAsync();

        static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureServices((_, services) =>
                    services.AddHostedService<Worker>()
                            .AddLogging(builder =>
                            {
                                var logger = new LoggerConfiguration()
                                            .MinimumLevel.Debug()
                                            .WriteTo.Console()
                                            .CreateLogger();

                                builder.AddSerilog(logger);
                            }));
    }
}

Worker.cs

namespace dotnet.console.app
{
    using System.Threading;
    using System.Threading.Tasks;
    using Microsoft.Extensions.Hosting;
    using Microsoft.Extensions.Logging;

    public class Worker : BackgroundService
    {
        private ILogger<Worker> _logger;

        public Worker(ILogger<Worker> logger)
        {
            this._logger = logger;
        }

        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            while (!stoppingToken.IsCancellationRequested)
            {
                this._logger.LogInformation("Hello, Serilog!");
                await Task.Delay(1000, stoppingToken);
            }
        }
    }
}

csproj

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net5.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" />
    <PackageReference Include="Serilog" Version="2.10.0" />
    <PackageReference Include="Serilog.Extensions.Logging" Version="3.0.1" />
    <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
    <PackageReference Include="Serilog.Sinks.File" Version="4.1.0" />
  </ItemGroup>

</Project>

Prolog · Accepted Answer · 2022-04-12 17:02:43Z

5

The built-in DI Mechanism in a .Net Core Console Application is available using Microsoft.Extensions.DependencyInjection package after DI package installation, configuring services is possible via instantiating a ServiceCollection instance. Serilog logging functionality can be added as follows.

var serviceProvider = new ServiceCollection()
                      .AddSingleton<IFoo, Foo>()
                      .AddSingleton<IBar, Bar>()
                      .AddLogging(builder =>
                      {
                          var logger = new LoggerConfiguration()
                          .MinimumLevel.Debug()
                          .WriteTo.Console()
                          .CreateLogger();

                          builder.AddSerilog(logger);
                      })
                      .BuildServiceProvider();

to have DI configurations encapsulated, configuration can be implemented in a class.

public class Startup
        {
            private ServiceProvider _serviceProvider;
            public Startup()
            {
                ConfigureServices();
            }

            private void ConfigureServices()
            {
                _serviceProvider = new ServiceCollection()
                      .AddSingleton<IFoo, Foo>()
                      .AddSingleton<IBar, Bar>()
                      .AddLogging(builder =>
                      {
                          var logger = new LoggerConfiguration()
                          .MinimumLevel.Debug()
                          .WriteTo.Console()
                          .CreateLogger();

                          builder.AddSerilog(logger);
                      })
                      .BuildServiceProvider();
            }

            public ServiceProvider Provider { get { return _serviceProvider; } }
        }

Then in the program main method, a new instance of Startup class should be created and starting point implementation can call using the provider property of the startup instance.

var startup = new Startup();
        startup.Provider.GetService<IFoo>().DoSomthing();

edited Apr 12, 2022 at 17:02

Prolog

3,4921 gold badge23 silver badges39 bronze badges

answered Feb 21, 2021 at 17:13

Hossein Salmanian

7534 silver badges14 bronze badges

6 Comments

Jesús López Over a year ago

To use AddSerilog method you also need Serilog.Extensions.Logging nuget package.

nop Over a year ago

Thanks for your answer! Can you give a complete example with an example class where you DI it

Xerillio Over a year ago

To be fair, this DI framework isn't any more built-in than the other DI frameworks, but it's probably more lightweight (just a guess though).

pinkfloydx33 Over a year ago

Use Serilog.Extensions.Hosting for a similar UseSerilog method on the host builder. No need to call AddLogging and it sets up all the loggers and providers correctly for a Host

Hossein Salmanian Over a year ago

@Xerillio Actually you are right. As .net core functionality is separated into packages, the DI isn't a built in feature anymore.

|

Tawab Wakil · Accepted Answer · 2023-05-09 14:15:24Z

2

Do I have to DI logger into all classes?

No, you don't. Although some may not prefer it, you can choose not to use DI at all for this and just configure the global logger:

Log.Logger = new LoggerConfiguration()
    .ReadFrom.Configuration(configuration)
    .CreateLogger();

The global logger is automatically accessible to any class that references the Serilog namespace, and can be called like this to log an entry:

Log.Logger.Information("Hello, world!");

answered May 9, 2023 at 14:15

Tawab Wakil

2,42328 silver badges43 bronze badges

Collectives™ on Stack Overflow

How to dependency inject Serilog into the rest of my classes in .NET Console App

Before with log4net:

My Serilog logger creation:

3 Answers 3

Program.cs:

Worker.cs

csproj

Comments

6 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

Before with log4net:

My Serilog logger creation:

3 Answers 3

Program.cs:

Worker.cs

csproj

Comments

6 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related