Overriding NLog settings with Azure Configuration

I have an app running in Azure and logging to a database. I've got the NLog settings coming from the appsettings.json file and everything seems to be working well. However, now I'd like to override the logging rules by adding an application setting to the app configuration in Azure and it's failing.

This is the NLog entry in the app settings.json:

"NLog": {
    "autoReload": true,
    "throwConfigExceptions": true,
    //"internalLogLevel": "Info",
    //"internalLogFile": "x:/internal-nlog.txt",
    "extensions": [
      { "assembly": "NLog.Extensions.Logging" },
      { "assembly": "NLog.Web.AspNetCore" },
      { "assembly": "NLog.Database" }
    ],
    "targets": {
      "async": true,
      "database": {
        "type": "Database",
        "dbProvider": "System.Data.SqlClient",
        "connectionString": "<Connection String>",
        "keepConnection": "true",
        "commandText": "insert into LoggingMessages(Created, MessageType, Message, CallSite, ExceptionDetail) values(getutcdate(), @level, @message, @callsite, @exception);",
        "parameters": [
          {
            "name": "@level",
            "layout": "${level}"
          },
          {
            "name": "@message",
            "layout": "${message}"
          },
          {
            "name": "@logger",
            "layout": "${logger}"
          },
          {
            "name": "@callsite",
            "layout": "${callsite}"
          },
          {
            "name": "@exception",
            "layout": "${exception:tostring}"
          }
        ]
      },
      "logconsole": {
        "type": "Console"
      }
    },
    "rules": [
      {
        "logger": "microsoft.*",
        "maxLevel": "Debug",
        "final": true
      },
      {
        "logger": "*",
        "minLevel": "Trace",
        "writeTo": "database"
      }
    ]
  }

This line is in the Configuration method of my startup.cs:

    var logger = LogManager.Setup()
        .LoadConfigurationFromAppSettings()
        .GetCurrentClassLogger();

And my CreateHostBuilder method in program.cs looks like this:

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
           webBuilder.UseStartup<Startup>();
        })
        .UseNLog();

Within the App Configuration screen on the Azure Portal I've then created the following Application Setting entry:

Name	Value
NLog:rules	[{"logger": "microsoft.","maxLevel": "Debug","final": true},{"logger": "","minLevel": "Warning","writeTo": "database"}]

I'm thinking that either the call to LoadConfigurationFromAppSettings() either happens too early or it ignores the updated values, but of course, I could just be completely wrong in what I'm trying to do.

Any help would be great

Upvotes: 0

Answers (4)

Rolf Kristensen

Reputation: 19877

To override a nested value inside the appsettings.json using Azure App Configuration then one must use __.

For example ApplicationInsights__InstrumentationKey will override this value in appsettings.json

"ApplicationInsights": {
    "InstrumentationKey": "Will be overrridden"
}

Notice to override nested value inside json-array requires extra magic (Ex. a specific NLog-Rule). You need to decorate with json-array-index-name. See also: https://github.com/NLog/NLog.Extensions.Logging/wiki/NLog-configuration-with-appsettings.json#logging-rule-override

Upvotes: 0

Rolf Kristensen

Reputation: 19877

Maybe add an Application Setting to the Azure App Configuration:

Name	Value
LoggingLevel	Debug

And use ${configsetting:LoggingLevel} in the NLog Logging Rule:

"NLog": {
    "autoReload": true,
    "throwConfigExceptions": true,
    "extensions": [
      { "assembly": "NLog.Extensions.Logging" },
      { "assembly": "NLog.Web.AspNetCore" },
      { "assembly": "NLog.Database" }
    ],
    "targets": {
      "async": true,
      "database": {
        "type": "Database",
        "dbProvider": "System.Data.SqlClient",
        "connectionString": "<Connection String>",
        "keepConnection": "true",
        "commandText": "insert into LoggingMessages(Created, MessageType, Message, CallSite, ExceptionDetail) values(getutcdate(), @level, @message, @callsite, @exception);",
        "parameters": [
          {
            "name": "@level",
            "layout": "${level}"
          },
          {
            "name": "@message",
            "layout": "${message}"
          },
          {
            "name": "@logger",
            "layout": "${logger}"
          },
          {
            "name": "@callsite",
            "layout": "${callsite}"
          },
          {
            "name": "@exception",
            "layout": "${exception:tostring}"
          }
        ]
      },
      "logconsole": {
        "type": "Console"
      }
    },
    "rules": [
      {
        "logger": "microsoft.*",
        "maxLevel": "Debug",
        "final": true
      },
      {
        "logger": "*",
        "minLevel": "${configsetting:LoggingLevel:whenEmpty=Trace}",
        "writeTo": "database"
      }
    ]
  }

Upvotes: 0

Andrew Bailie

Reputation: 37

So I couldn't get this to work the way I thought it should - just replacing the current rules - but I got it to work in the way that I need it. All I really wanted to do was change the minimum level for the database rule so that I could adjust this without having to update the code.

What I ended up doing was adding an Application Setting in the Azure App Configuration: |Name|Value| |----|-----| |LoggingLevel|Debug|

then adding some code similar to the following to the Configuration method of the startup.cs after the existing LogManager setup line.

var loggingLevel = Configuration.GetValue<string>("LoggingLevel");
var haveNewLoggingLevel = !string.IsNullOrWhiteSpace(loggingLevel);

// only interested in the 'database' target
var databaseTarget = LogManager.Configuration.FindTargetByName("database") as DatabaseTarget;

if ((databaseTarget != null) && haveNewLoggingLevel)
{
    var rules = LogManager.Configuration.LoggingRules;
    foreach (var rule in rules)
    {
        if (rule.Targets.Contains(databaseTarget))
        {
            rule.SetLoggingLevels(NLog.LogLevel.FromString(loggingLevel), NLog.LogLevel.Fatal);
        }
    }

    LogManager.ReconfigExistingLoggers();
}

With this I was able to achieve what I needed, butt I'm not sure it answers the question I originally asked. I also added similar code to update the connection string to the database from App Settings.

Upvotes: 0

Zhenlan Wang

Reputation: 1543

The key-value ("NLog:rules") you created in Azure App Configuration is a JSON object. Make sure you set JSON content-type for it. Otherwise, it will be loaded as a string. For more information, see Use content type to store JSON key-values in App Configuration.

I don't see your code that loads data from Azure App Configuration.

Update your code to use App Configuation by following Quickstart: Create an ASP.NET Core app with Azure App Configuration.
I'm not very familiar with NLog, but you need to make sure NLog can load configuration from the system IConfiguration.

Upvotes: 0

Overriding NLog settings with Azure Configuration

Answers (4)

Related Questions