NLog.LogManager.Setup() - Introduced LoadConfiguration and friends for ISetupBuilder #3871

snakefoot · 2020-03-31T18:09:25Z

Very small dive into the idea of fluent-api for setup of NLog-LoggingConfiguration:

LogManager.Setup().LoadConfigurationFromFile();

LogManager.Setup().LoadConfigurationFromFile("NLog.config", optional: false);

LogManager.Setup().LoadConfigurationFromXml("<nlog></nlog>");

LogManager.Setup().LoadConfiguration(nlogConfig);

LogManager.Setup().LoadConfiguration(builder => 
  // Targets where to log to: File and Console
  var logfile = new NLog.Targets.FileTarget("logfile") { FileName = "file.txt" };
  var logconsole = new NLog.Targets.ConsoleTarget("logconsole");
            
  // Rules for mapping loggers to targets            
  builder.Configuration.AddRule(LogLevel.Info, LogLevel.Fatal, logconsole);
  builder.Configuration.AddRule(LogLevel.Debug, LogLevel.Fatal, logfile);
);

This will match the PRs here:

NLog/NLog.Extensions.Logging#418
NLog/NLog.Web#540

This allows one to setup a fallback configuration, if no NLog.config file was found:

LogManager.Setup().LoadConfigurationFromFile().LoadConfiguration(builder =>{
  var config = builder.LogFactory.Configuration;
  if (config != null)
        return;   // Config already assigned and loaded

  // Targets where to log to: File and Console
  var logconsole = new NLog.Targets.ConsoleTarget("logconsole");
            
  // Rules for mapping loggers to targets            
  builder.Configuration.AddRule(LogLevel.Info, LogLevel.Fatal, logconsole);
}));

Or one can so this (Resolves almost #1429, but without autoReload=true support)

LogManager.Setup().LoadConfigurationFromFile().LoadConfiguration(builder => {
   // Dynamically adds the console-target after having loaded from NLog.config
   var consoleTarget = new ColoredConsoleTarget("console");
   builder.Configuration.AddRule(LogLevel.Info, LogLevel.Fatal, consoleTarget);
}));

One can also setup support for loading NLog.config first in Process-Directory (Before NLog5 is released)

var processDir = Path.GetDirectoryName(Process.GetCurrentProcess().MainModule.FileName);
LogManager.Setup().
   LoadConfigurationFromFile(Path.Combine(processDir, "NLog.config"), optional: true).
   LoadConfigurationFromFile();  // Skips loading of default NLog.config if config already loaded

snakefoot · 2020-03-31T18:11:04Z

Notice no unit-tests yet, because I'm guessing we are entering discussion mode first.

304NotModified · 2020-04-09T19:16:46Z

This allows one to setup a fallback configuration, if no NLog.config file was found:

LogManager.Setup().LoadNLogConfigFromFile().LoadNLogConfig(builder =>{
var config = builder.LogFactory.Configuration;
if (config != null)
        return;   // Config already assigned and loaded

// Targets where to log to: File and Console
var logconsole = new NLog.Targets.ConsoleTarget("logconsole");

// Rules for mapping loggers to targets            
builder.Configuration.AddRule(LogLevel.Info, LogLevel.Fatal, logconsole);
}));

How does this works if we load from file and enhance it from API? (so it isn't a fallback). And if we do reload, does that work then?

Notice no unit-tests yet, because I'm guessing we are entering discussion mode first.

I think it's nice! Only some naming things I guess

snakefoot · 2020-04-09T19:57:34Z

How does this works if we load from file and enhance it from API? (so it isn't a fallback). And if we do reload, does that work then?

Notice that the two last code-examples are a little different (fallback when no config):

LogManager.Setup().LoadNLogConfigFromFile().LoadNLogConfig(builder =>{
var config = builder.LogFactory.Configuration;
if (config != null)
        return;   // Config already assigned and loaded (So no need to create fallback config

And the other (enhancing loaded config):

LogManager.Setup().LoadNLogConfigFromFile().LoadNLogConfig(builder =>{
  // Enhances the existing config (Automatically creates new Configuration if none loaded)
  builder.Configuration.AddRule(LogLevel.Info, LogLevel.Fatal, consoleTarget);

Ofcourse with autoReload="true" then all is lost, when enhancing loaded config (reload on file-change will not automatically apply runtime changes). I guess people who are into such exotic scenario will come with some great use-cases and suggestions for how to implement that logic. Much easier to work actual use-cases than trying to predict everything.

Like I said in my introduction of this. Then it is a very small dive into the fluent-setup of NLog-config.

snakefoot · 2020-04-09T20:34:29Z

I think it's nice! Only some naming things I guess

Created some unit-tests that increases code-coverage.

snakefoot · 2020-04-10T19:38:03Z

Btw. happy to see that NLog 4.7.0 seems to be swimming nicely along without any major issues. Not like NLog 4.6.0 where my refactoring of XmlLoggingConfiguration (To load NLog.config from appsettings.json) caused all kind of bad experiences.

But maybe I have just jinxed it, and the radio-silence comes from the corona dance :)

snakefoot · 2020-04-20T18:46:03Z

Should we include a CreateLogger() or GetCurrentClassLogger() / GetLogger() as extension-methods to ISetupBuilder ?

If you would like to remove the LogFactory-indirection ?

So this:

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

Becomes this:

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

304NotModified · 2020-04-20T19:07:26Z

Should we include a CreateLogger() or GetCurrentClassLogger() / GetLogger() as extension-methods to ISetupBuilder ?

Sounds good! GetCurrentClassLogger() / GetLogger() sounds as the best option!

snakefoot · 2020-04-20T19:44:10Z

Sounds good! GetCurrentClassLogger() / GetLogger() sounds as the best option!

Created PR #3909

304NotModified · 2020-04-20T19:58:01Z

One name thing, would it be easier? (So drop the NLog in the name)

LogManager.Setup().LoadConfigFromFile().LoadConfig(logBuilder =>{ ...

snakefoot · 2020-04-20T19:59:33Z

One name thing, would it be easier? (So drop the NLog in the name)

I did that on purpose, because there is both "NLog.config" and "appsettings.json" and "app.config". All of them are files.

NLog gives special love and attention to NLog.config so yes it is the favorite file, but not the only one.

304NotModified · 2020-04-20T20:02:58Z

I did that on purpose, because there is both "NLog.config" and "appsettings.json" and "app.config". All of them are files.

Ah well I expected that "appsettings.json" and "app.config" would work (in the future) 👼

What about LoadConfig etc, and adding a optional "logFileType" parameter?

304NotModified · 2020-04-20T20:05:09Z

What about LoadConfig etc, and adding a optional "logFileType" parameter?

Ow that won't scale nice between other packages.

I stil prefer LoadConfig, but I think "appsettings.json" should be named other, e.g. LoadConfigFromAppsettingsJson

snakefoot · 2020-04-20T20:06:32Z

Ah well I expected that "appsettings.json" and "app.config" would work (in the future)

Never going to happen, since all of them have different dependencies, so they would require different assemblies (and extension-methods). Just like you see is happening in NLog.Extension.Logging and Nlog.Web.

P.S. It was my dream when I introduced LogManager.LoadConfiguration but now see it was a mistake.

304NotModified · 2020-04-09T19:14:07Z

src/NLog/SetupBuilderExtensions.cs

+        /// <summary>
+        /// Loads NLog config from filename <paramref name="configFile"/> if provided, else fallback to scanning for NLog.config
+        /// </summary>
+        public static ISetupBuilder LoadNLogConfigFromFile(this ISetupBuilder setupBuilder, string configFile = null, bool optional = true)


nitpick: configFilePath?

Sounds like one is only giving the candidate-path to the NLog.config file. Not sure it is an improvement.

well configFile sounds a bit like the content of the configFile.

304NotModified · 2020-04-20T20:07:21Z

my dream

To what is this referring?

snakefoot · 2020-04-20T20:07:47Z

To what is this referring?

My dream that LogManager.LoadConfiguration should load all kind of files.

304NotModified · 2020-04-20T20:17:20Z

ow yes, that would be nice.

But you still prefer LoadNLogConfig over LoadConfig? I never saw the relation between "NLog" word and NLog.config (as dumb user is still would try LoadNLogConfig("appsettings.json"))

snakefoot · 2020-04-20T20:31:20Z

Yes to me LoadNLogConfig is better than LoadConfig. As it signals the file has to match the format of NLog.config. And the contents of the config is the NLog LoggingConfiguration, and not some other config.

snakefoot · 2020-04-20T20:35:07Z

I guess these two methods could have different name:

LogManager.Setup().LoadNLogConfig(nlogConfig);

LogManager.Setup().LoadNLogConfig(builder => )

Could also be called:

LogManager.Setup().LoadLoggingConfiguration(nlogConfig);

LogManager.Setup().LoadLoggingConfiguration(builder => )

snakefoot · 2020-04-22T06:46:46Z

Changed builder-method from LogFactory to ISetupNLogConfigBuilder then one can create config-extension-methods for the interface instead of for LogFactory.

304NotModified · 2020-04-26T11:46:37Z

I guess these two methods could have different name:

LogManager.Setup().LoadNLogConfig(nlogConfig);

LogManager.Setup().LoadNLogConfig(builder => )

Could also be called:

LogManager.Setup().LoadLoggingConfiguration(nlogConfig);

LogManager.Setup().LoadLoggingConfiguration(builder => )

That's IMO better. I don't think "NLog Should be in a method name, as we're already in a NLog context.

Why about LogManager.Setup().LoadConfiguration? It is consistent with LogManager.LoadConfiguration then.

…r ISetupBuilder

snakefoot · 2020-04-26T12:23:12Z

Why about LogManager.Setup().LoadConfiguration?

Have updated the PR with the new names.

Some adjustment is needed for:

NLog/NLog.Extensions.Logging#412
NLog/NLog.Web#540

sonarqubecloud · 2020-04-26T12:38:14Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
5 Code Smells

98.7% Coverage
0.0% Duplication

304NotModified · 2020-04-28T17:57:12Z

Cool! Thanks!

snakefoot · 2021-11-23T22:49:58Z

Created wiki-page: https://github.com/NLog/NLog/wiki/Fluent-Configuration-API

pull-request-size bot added the size/L label Mar 31, 2020

snakefoot added this to the 4.7.1 milestone Mar 31, 2020

snakefoot added the enhancement Improvement on existing feature label Mar 31, 2020

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch from e019da5 to 80204a8 Compare March 31, 2020 18:13

snakefoot mentioned this pull request Mar 31, 2020

Add Configuration.CombineConfig(config => config) #1429

Closed

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch from 80204a8 to 36a65b6 Compare March 31, 2020 18:27

304NotModified self-assigned this Mar 31, 2020

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch from 36a65b6 to 501d5c2 Compare March 31, 2020 18:31

snakefoot mentioned this pull request Mar 31, 2020

No way to use LogFactory with AspNet.Core NLog/NLog.Web#541

Closed

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch 5 times, most recently from e725aa2 to 0a04748 Compare March 31, 2020 20:59

snakefoot added the needs documentation on wiki label Apr 1, 2020

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch 5 times, most recently from 1c6b161 to 833b721 Compare April 3, 2020 04:37

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch 3 times, most recently from 378f07e to cb39c21 Compare April 9, 2020 21:59

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch from cb39c21 to 5ec96ae Compare April 13, 2020 22:16

304NotModified reviewed Apr 20, 2020

View reviewed changes

304NotModified closed this Apr 25, 2020

304NotModified reopened this Apr 25, 2020

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch from 426c07b to cfe7104 Compare April 26, 2020 12:21

NLog.LogManager.Setup() - Introduced LoadConfiguration and friends fo…

5f8f17f

…r ISetupBuilder

snakefoot force-pushed the SetupBuilderLoadNLogConfig branch from cfe7104 to 5f8f17f Compare April 26, 2020 12:21

snakefoot changed the title ~~NLog.LogManager.Setup() - Introduced LoadNLogConfig and friends for ISetupBuilder~~ NLog.LogManager.Setup() - Introduced LoadConfiguration and friends for ISetupBuilder Apr 26, 2020

snakefoot mentioned this pull request Apr 26, 2020

Renaming LoadNLogConfigFromSection to LoadConfigurationFromSection NLog/NLog.Extensions.Logging#418

Merged

304NotModified merged commit b21c64a into NLog:master Apr 28, 2020

snakefoot added the documentation done all docs done (wiki, api docs, lists on nlog-project.org, xmldocs) label Nov 23, 2021

snakefoot deleted the SetupBuilderLoadNLogConfig branch July 30, 2022 10:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NLog.LogManager.Setup() - Introduced LoadConfiguration and friends for ISetupBuilder #3871

NLog.LogManager.Setup() - Introduced LoadConfiguration and friends for ISetupBuilder #3871

snakefoot commented Mar 31, 2020 •

edited

Loading

snakefoot commented Mar 31, 2020 •

edited

Loading

304NotModified commented Apr 9, 2020 •

edited by snakefoot

Loading

snakefoot commented Apr 9, 2020 •

edited

Loading

snakefoot commented Apr 9, 2020

snakefoot commented Apr 10, 2020

snakefoot commented Apr 20, 2020 •

edited

Loading

304NotModified commented Apr 20, 2020

snakefoot commented Apr 20, 2020

304NotModified commented Apr 20, 2020 •

edited by snakefoot

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

304NotModified commented Apr 20, 2020

304NotModified commented Apr 20, 2020

snakefoot commented Apr 20, 2020 •

edited

Loading

304NotModified Apr 9, 2020

snakefoot Apr 20, 2020

304NotModified Apr 26, 2020

304NotModified commented Apr 20, 2020

snakefoot commented Apr 20, 2020 •

edited

Loading

304NotModified commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 22, 2020

304NotModified commented Apr 26, 2020

snakefoot commented Apr 26, 2020 •

edited

Loading

sonarqubecloud bot commented Apr 26, 2020

304NotModified commented Apr 28, 2020

snakefoot commented Nov 23, 2021

NLog.LogManager.Setup() - Introduced LoadConfiguration and friends for ISetupBuilder #3871

NLog.LogManager.Setup() - Introduced LoadConfiguration and friends for ISetupBuilder #3871

Conversation

snakefoot commented Mar 31, 2020 • edited Loading

snakefoot commented Mar 31, 2020 • edited Loading

304NotModified commented Apr 9, 2020 • edited by snakefoot Loading

snakefoot commented Apr 9, 2020 • edited Loading

snakefoot commented Apr 9, 2020

snakefoot commented Apr 10, 2020

snakefoot commented Apr 20, 2020 • edited Loading

304NotModified commented Apr 20, 2020

snakefoot commented Apr 20, 2020

304NotModified commented Apr 20, 2020 • edited by snakefoot Loading

snakefoot commented Apr 20, 2020 • edited Loading

304NotModified commented Apr 20, 2020

304NotModified commented Apr 20, 2020

snakefoot commented Apr 20, 2020 • edited Loading

304NotModified Apr 9, 2020

Choose a reason for hiding this comment

snakefoot Apr 20, 2020

Choose a reason for hiding this comment

304NotModified Apr 26, 2020

Choose a reason for hiding this comment

304NotModified commented Apr 20, 2020

snakefoot commented Apr 20, 2020 • edited Loading

304NotModified commented Apr 20, 2020 • edited Loading

snakefoot commented Apr 20, 2020 • edited Loading

snakefoot commented Apr 20, 2020 • edited Loading

snakefoot commented Apr 22, 2020

304NotModified commented Apr 26, 2020

snakefoot commented Apr 26, 2020 • edited Loading

sonarqubecloud bot commented Apr 26, 2020

304NotModified commented Apr 28, 2020

snakefoot commented Nov 23, 2021

snakefoot commented Mar 31, 2020 •

edited

Loading

snakefoot commented Mar 31, 2020 •

edited

Loading

304NotModified commented Apr 9, 2020 •

edited by snakefoot

Loading

snakefoot commented Apr 9, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

304NotModified commented Apr 20, 2020 •

edited by snakefoot

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

304NotModified commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 20, 2020 •

edited

Loading

snakefoot commented Apr 26, 2020 •

edited

Loading