c# - 从 appsettings.json 获取 Nlog 值

Question

我的目标是将 appsettings.json 中的值注入(inject)到 ASP.NET Core 应用程序的 nlog.config 中。我正在使用 NLog.Web.AspNetCore 4.8.3、NLog 4.6.5、NLog.config 4.6.5 和 Microsoft.Extensions.Logging.Abstractions 2.0.0。

我无法让它工作。我的印象是 ${configsetting:name=ConnectionStrings.ApplicationDatabase} 将替换为我的 appsettings.json 文件中的 ConnectionStrings.ApplicationDatabase 值，但这不会工作。 nlog.config 变量值未更改，并且在我运行我的应用程序时抛出错误，因为这是一个无效的连接字符串。

nlog.config 的片段

<!-- Using logDirectory variable to set path to src/logs folder in allfile and ownFile-web targets below -->
  <variable name="logDirectory" value="${basedir}/../../../logs/${shortdate}/internal-nlog.log" />
  <variable name="logDatabase" value="${configsetting:name=ConnectionStrings.ApplicationDatabase}"/>
  <variable name="logDatabaseUser" value="${configsetting:name=DatabaseCredentials.User}"/>
  <variable name="logDatabasePassword" value="${configsetting:name=DatabaseCredentials.Password}"/>-->
  <variable name="logConnectionString" value="mongodb://${logDatabaseUser}:${logDatabasePassword}@${logDatabase}/myApplicationDB?authSource=admin"/>

  <!-- Load the ASP.NET Core plugin -->
  <extensions>
    <add assembly="NLog.Web.AspNetCore" />
    <add assembly="NLog.Mongo" />
  </extensions>

  <!-- the targets to write to -->
  <targets>
    <!-- write logs to file -->
    <target xsi:type="File" name="allfile" fileName="${logDirectory}"
            layout="${longdate}|${event-properties:item=EventId.Id}|${logger}|${uppercase:${level}}|${message} ${exception}" />

    <!-- another file log, only own logs. Uses some ASP.NET core renderers -->
    <target xsi:type="File" name="ownFile-web" fileName="${logDirectory}"
            layout="${longdate}|${event-properties:item=EventId.Id}|${logger}|${uppercase:${level}}|  ${message} ${exception}|url: ${aspnet-request-url}|action: ${aspnet-mvc-action}" />

    <target xsi:type="Mongo" name="error-mongo"
            connectionString="${logConnectionString}"
            collectionName="errorLogs">
      <field name="date" layout="${date}" bsonType="DateTime" />
      <field name="level" layout="${level}" />
      <field name="message" layout="${message}" />
      <field name="logger" layout="${logger}" />
      <field name="exception" layout="${exception:format=tostring}" />
      <field name="threadID" layout="${threadid}" bsonType="Int32" />
      <field name="threadName" layout="${threadname}" />
      <field name="processID" layout="${processid}" bsonType="Int32" />
      <field name="processName" layout="${processname:fullName=true}" />
      <field name="userName" layout="${windows-identity}" />
    </target>

<target xsi:type="Mongo" name="event-mongo"
         connectionString="${logConnectionString}"
         collectionName="eventLogs">
      <field name="date" layout="${date}" bsonType="DateTime" />
      <field name="level" layout="${level}" />
      <field name="event" layout="${event-properties:item=EventId.Id}" />
      <field name="message" layout="${message}" />
      <field name="logger" layout="${logger}" />
    </target>
  </targets>

appsetting.json 的片段

  "ConnectionStrings": {
    "ApplicationDatabase": "App-db-server-1.com:27017,App-db-server-2.com:27017,App-db-server-3.com:27017/AccessManagement?ssl=true&replicaSet=myReplicaSet&authSource=admin"
  },
  "DatabaseCredentials": {
    "User": "",
    "Password": ""
  }
}

startup.cs 的片段

   // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            if (env.IsDevelopment())
                app.UseDeveloperExceptionPage();

            ConfigureNLog(app, loggerFactory);

            /*These settings need to be changed*/
            app.UseCors(
                options => options
                    .AllowAnyOrigin()
                    .AllowAnyMethod()
                    .AllowAnyHeader()
            );

            app.UseAuthentication();
            //Swagger Set Up
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Authentication API V1");
            });
            app.UseMvc();
        }

        private static void ConfigureNLog(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            IConfigurationRoot config = new ConfigurationBuilder()
                .AddJsonFile(path: "appSettings.json").Build();
            NLog.Extensions.Logging.ConfigSettingLayoutRenderer.DefaultConfiguration = config;
        }

**Program.cs 片段

    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }

        public static IWebHost BuildWebHost(string[] args)
        {
            return WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>()
                .ConfigureLogging(logging =>
                {
                    logging.ClearProviders();
                    logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);
                })
                .UseNLog()
                .Build();
        }
    }

Answer 1

来自 https://github.com/NLog/NLog/wiki/ConfigSetting-Layout-Renderer

当从 NLog.Web.AspNetCore 或 NLog.Extensions.Hosting 调用 UseNLog() 时，它会自动注册托管环境配置ConfigSettingLayoutRenderer。

使用 ${configsetting} 手动注册 Microsoft Extension IConfiguration:

IConfigurationRoot config = new ConfigurationBuilder()
    .AddJsonFile(path: "AppSettings.json").Build();
NLog.Extensions.Logging.ConfigSettingLayoutRenderer.DefaultConfiguration = config;

在这里更新，演示案例https://github.com/304NotModified/NLog-Demo-cases/tree/master/AspNetCore2WithConfigSetting