NLog 在NetCore中实现多实例注入DI, 实现多租户模式

通常, 我们在使用了 Microsoft.Extensions.DependencyInjection DI框架的情况下, 我们一般通过

.ConfigureLogging((HostBuilderContext host, ILoggingBuilder logBuilder)=>{
      logBuilder.AddNLog(...)
})

或者

.ConfigureWebHostDefaults(builder=>{
      builder.UseStartup<Startup>()
             .UseNLog(...)
})

等方式将NLog配置进入DI系统.

但是, 如果我们的DI用于多租户模式,像这样的NLog没法做到完全隔离.

因为在其内部都是使用的是一个默认的LogManager.LogFactory 静态的 NLog.LogFactory 对象, 所以在多次初始化的时候会发生配置覆盖的情况.

例如下面的这个例子:

//user1_services 的nlog配置会被user2_services的nlog配置覆盖, 我们就没法实现多租户(user1, user2)的完全隔离了. 不能实现不同的用户写入不同的地方(provider),使用不同的format, 不同的log level等.

ServiceCollection user1_services= new ServiceCollection();
user1_services.AddLogging(logBuilder=>{
      logBuilder.AddNLog(...)
})
ServiceCollection user2_services= new ServiceCollection();
user2_services.AddLogging(logBuilder=>{
      logBuilder.AddNLog(...)
})

所以, 我们要解决这个问题则要自定义使用的的LogFactory.

var nlogFactory = new NLog.LogFactory(new NLogLoggingConfiguration(configuration.GetSection("active_user_nlog_options"))); // nlog的配置选项, targets, rules 等等.
var nlogProviderOptions = configuration.GetSection("active_user_nlog_provider_options").Get<NLogProviderOptions>();// IncludeScopes, ParseMessageTemplates, IgnoreEmptyEventId 等配置选项
var nlogLoggerProvider = new NLogLoggerProvider(nlogProviderOptions, nlogFactory );
loggerBuilder.AddProvider(nlogLoggerProvider);
//或者
loggerBuilder.AddNLog(sp => new NLog.LogFactory(...));

需要注意的是还有一个feature要注意使用方式, 文档参考:https://github.com/NLog/NLog/wiki/ConfigSetting-Layout-Renderer

因为这货也是一个静态变量在维护, 可以通过NLog.LayoutRenderers.LayoutRenderer.Register("configsetting","NLog.Extensions.Logging.ConfigSettingLayoutRenderer")替换掉默认实现.

//默认实现.
private static IConfiguration SetupConfiguration(IServiceProvider serviceProvider, IConfiguration configuration)
{
    configuration = (configuration ?? (serviceProvider?.GetService(typeof(IConfiguration)) as IConfiguration));
    if (configuration != null)
    {
        ConfigSettingLayoutRenderer.DefaultConfiguration = configuration;
    }

    return configuration;
}

至于是否还有其他的坑, 还得踩进去才知道, 日常记录, 以供参考