Pass ILogger or ILoggerFactory to constructors in AspNet Core?

13,356

This is more of a design issue.

The controller should not be creating child classes anyway. That is not a concern the controller should be dealing with and goes against SRP (Single Responsibility Principle).

My question is what should I pass to child classes called from my controller

If your preference is to separate the loggers, then there really isn't any other choice here than to have child (dependent) classes have their own loggers.

Have child classes inject their own logger

public class TodoRepository : ITodoRepository {
    private readonly ILogger logger; 

    public TodoRepository(ILogger<TodoRepository> logger) { 
        this.logger = logger;   
    }
  
    //...
}

and then inject the child class into the controller.

public class TodoController : Controller {
    private readonly ILogger logger;
    private readonly ITodoRepository todoRepository;

    public TodoController(ILogger<TodoController> logger, ITodoRepository todoRepository) {
        this.logger = logger;   
        this.todoRepository = todoRepository;
    }

    //...
}

That way, the child loggers will get resolved when the child classes are being resolved and injected into the controller.

Share:
13,356
Michael Freidgeim
Author by

Michael Freidgeim

I am .Net developer. Blog http://mfreidge.Wordpress.com/, twice awarded Geekswithblogs.net Influencer , a few times achieved the first position in Geekswithblogs Top Geeks List

Updated on June 03, 2022

Comments

  • Michael Freidgeim
    Michael Freidgeim almost 2 years

    The MS docs article "Introduction to Logging in ASP.NET Core" gives 2 examples of constructor injection

    • using ILogger

      private readonly ILogger _logger;   
      public TodoController(ILogger<TodoController> logger)  
      { 
          _logger = logger;   
      }
      
    • and ILoggerFactory

      private readonly ILogger _logger;  
      public TodoController( ILoggerFactory loggerFactory)  
      {  
          _logger = loggerFactory.CreateLogger<TodoController>();  
      }
      

    My question is what should I pass to child classes called from my controller

    • pass ILoggerFactory to my child classes called from the controller and in each class call LoggerFactoryExtensions.CreateLogger<MyChildClass>() or

    • pass parent controller's ILogger<MyController> to each child class created from the controller and having non-generic parameter ILogger.

    In logs I prefer to see separate category 'MyChildClass' for each class, rather than all classes use the category 'MyController' from the parent controller.
    However CreateLogger in each object construction can be an expensive operation (e.g. see https://github.com/aspnet/Logging/issues/524)

    Which option will you recommend? Can you suggest any other approach?