(Question) Usage in class library

Type (choose one):

• Question

Hi!

This is a question more around how this package should be integrated with class libraries consumed via NuGet. I maintain a project over at https://github.com/techyian/MMALSharp, and I’ve just finished adding Microsoft.Extensions.Logging.Abstractions so I’m not forcing users to use NLog (as was the case previously). The way I’ve wired up the logging can be found here, and I’m using factory.AddNLog().AddSerilog(); when configuring the ILoggerFactory. This works well, and I’ve opened up the LoggerFactory property so if users want to override the factory being used with their own instance (for example if they just want to use Microsoft.Extensions.Logging with a console provider) then they can.

I just wanted to learn from you whether this is the correct way of approaching this?

Thank you 😃

[snakefoot]

Another example is TorrentCore that has embraced dependency injection completely and creates all its objects using IServiceProvider:

https://github.com/SamuelFisher/torrentcore

This of course introduces an extra dependency, since it now relies on Microsoft Extension Logging AND Microsoft Dependency Injection

[snakefoot]

I guess only Microsoft are following their own ideal guidelines 😃

For example MassTransit expects people to assign the custom ILoggerFactory before creating the instance:

https://masstransit-project.com/getting-started/upgrade-v6.html#logging

If I was lazy then I would probably create a custom implementation of ILogger similar to this:

public static class MMALLog
{
     public static Microsoft.Extensions.Logging.ILogger Logger => _logger;
     private static readonly MMALLogger _logger = new MMALLogger();

     public static ILoggerFactory LoggerFactory
     {
         get => _logger.LoggerFactory;
         set => _logger.LoggerFactory = value;
     }

     class MMALLogger : ILogger
     {
            public ILoggerFactory LoggerFactory 
            {
                get { return _loggerFactory; }
                set
                {
                    _loggerFactory = value;
                    _logger = null;
                } 
            }
            private ILoggerFactory _loggerFactory;
            private ILogger _logger;
            private ILogger Logger => _logger ?? (_logger = _loggerFactory?.CreateLogger("MMALSharp"));

            IDisposable ILogger.BeginScope<TState>(TState state)
            {
                return Logger?.BeginScope(state);
            }

            bool ILogger.IsEnabled(LogLevel logLevel)
            {
                return Logger?.IsEnabled(logLevel) ?? false;
            }

            void ILogger.Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
            {
                Logger?.Log(logLevel, eventId, state, exception, formatter);
            }
     }
}

Then users just need to assign this property before using your library:

MMALSharp.Common.Utility.MMALLog.LoggerFactory = myLoggerFactory;

Then just leave everything as before without changing anything else.