以编程方式重新配置NLog

时间:2012-04-24 17:02:47

标签: .net logging nlog

这是我第一次使用NLog软件包进行日志记录,但到目前为止,它一直很好用。

在我的场景中,我需要以编程方式初始化我的NLog LoggingConfiguration设置,而不是通过更典型的配置文件方案。我已经对它进行了测试,并将其全部按照默认方式运行。但是,如何在运行时以编程方式修改我的设置?这里最常见的情况可能是默认情况下应用程序的日志记录级别设置为ERROR,但在特定模块中出现错误,我希望将日志记录级别切换为更加冗长以跟踪错误。我想编写一个小的Web界面,以便我可以在运行时轻松调整这些设置,但我想确保我采用正确的方法。

7 个答案:

答案 0 :(得分:69)

我知道我迟了一年但是我遇到了类似的情况,我需要向用户提供对记录器的动态控制。幸运的是,使用nlog相对容易。在这里,我只是为已经创建的Logger启用跟踪级别日志记录,但显然您可以执行任何您想要的操作,包括添加新的目标/规则,或者只是用编程生成的LoggerConfiguration完全替换LoggerConfiguration。

Basic ColoredConsole nlog.config:

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <targets>
    <target xsi:type="ColoredConsole" name="c"
            layout="${longdate} ${uppercase:${level}} ${message}" />
  </targets>
  <rules>
    <logger name="*" minlevel="Error" writeTo="c" />
  </rules>
</nlog>

简单的控制台应用程序:

public class Program 
{
  //Initialize default Logger from config file
  private static readonly Logger m_log = LogManager.GetCurrentClassLogger();

  public static Logger Log 
  {
      get { return m_log; }
  }

  public static void Main(string[] args) 
  {
    Log.Trace("You won't see me because config is at LogLevel.Error");
    EnabledTraceForAllRules();
    Log.Trace("You will see me now though!");

    //Pause console window
    Console.WriteLine("Press any key to continue...");
    Console.ReadKey(true);

    /* Prints:
    2013-05-07 16:04:22.7050 TRACE You will see me now though!
    Press any key to continue...
    */
  }

  public static void EnabledTraceForAllRules() 
  {
    foreach(var rule in LogManager.Configuration.LoggingRules)
    {
      rule.EnableLoggingForLevel(LogLevel.Trace);
    }

    //Call to update existing Loggers created with GetLogger() or 
    //GetCurrentClassLogger()
    LogManager.ReconfigExistingLoggers();
  }
}

如果您需要从进程外部更改Logging配置并且必须以编程方式完成,我建议您使用WCF。您可以从提供重新配置nlog的方法的应用程序或网站公开一个小型WCF服务。

答案 1 :(得分:4)

我在NLog文档(https://github.com/nlog/NLog/wiki/Configuration-API)中找到了“配置API”,可能对您有帮助。在NLog程序集中也可以查看NLog.Config命名空间。

答案 2 :(得分:1)

我在下面包括的NLog教程页面here中提供了程序化的初始设置示例。 (有一个更广泛的版本here。)

public static void Startup()
{
    var config = new NLog.Config.LoggingConfiguration();

    // 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            
    config.AddRule(LogLevel.Info, LogLevel.Fatal, logconsole);
    config.AddRule(LogLevel.Debug, LogLevel.Fatal, logfile);

    // Apply config           
    NLog.LogManager.Configuration = config;
    LogManager.ReconfigExistingLoggers();
}

然后,更改日志级别,其中logconsole是要更改的目标:

public static void SetConsoleLogLevel(LogLevel level)
{
    foreach (var rule in LogManager.Configuration.LoggingRules)
    {
        foreach (var ruleTarget in rule.Targets)
        {
            if (ruleTarget != logconsole) continue;

            DisableLoggingForLevels(rule, LogLevel.Trace, level);
            rule.EnableLoggingForLevels(level, LogLevel.Fatal);
            LogManager.GetCurrentClassLogger().Log(level, "Changed logger level to {0}", level);
        }
    }

    LogManager.ReconfigExistingLoggers();
}

其中DisableLoggingForLevels是与NLog.Config.LoggingRule.EnableLoggingForLevels完全相同的私有方法,除了它禁用:

private static void DisableLoggingForLevels(LoggingRule rule, LogLevel minLevel, LogLevel maxLevel)
{
    for (var ordinal = minLevel.Ordinal; ordinal <= maxLevel.Ordinal; ++ordinal)
        rule.DisableLoggingForLevel(LogLevel.FromOrdinal(ordinal));
}

答案 3 :(得分:1)

我看到一次启用一个级别的答案,但是如果要镜像NLog.config文件的行为,其中设置单个级别还会启用所有更高优先级的级别(并禁用较低优先级的级别),则需要启用使用SetLoggingLevels这样的一系列级别:

NLog.config:

  <rules>
    <logger name="*" minlevel="Trace" writeTo="your-target-name" />
  </rules>

代码:

public static void SetLogLevel(LogLevel newLogLevel)
{
    foreach (var rule in LogManager.Configuration.LoggingRules)
    {
        foreach (var target in rule.Targets)
        {
            if (target.Name == "your-target-name")
            {
                rule.SetLoggingLevels(newLogLevel, LogLevel.Fatal);
            }

        }
    }

    LogManager.ReconfigExistingLoggers();
}

来自NLog文档:

public void SetLoggingLevels(LogLevel minLevel, LogLevel maxLevel);
     

启用记录minLevelmaxLevel之间的级别的功能   df = pd.DataFrame( {'int_col': [1, 2, 3], 'float_col': [1.1, 2.2, 3.3], 'obj_col': list('abc')}) >>> [col for col in df if df[col].dtype in [np.dtype(t) for t in ('int', 'float')]] ['int_col', 'float_col'] 。其他所有级别都将被禁用。

答案 4 :(得分:1)

NLog 4.6.7引入了在LoggingRules中使用布局逻辑的功能。因此,您可以拥有一个NLog.config,其中包含可在运行时轻松调整的日志记录规则:

<nlog>
   <variable name='myLevel' value='Warn'/>
    <rules>
      <logger minLevel='${var:myLevel}' writeTo="your-target-name" />
    </rules>
</nlog>

然后可以在运行时更新myLevel

LogManager.Configuration.Variables["myLevel"] = "Debug";
LogManager.ReconfigExistingLoggers();

另请参阅:https://github.com/NLog/NLog/wiki/Filtering-log-messages#semi-dynamic-routing-rules

答案 5 :(得分:1)

using NLog;

private void SetLogLevel(LogLevel level)
{
  LogManager.GlobalThreshold = level;
}

答案 6 :(得分:0)

大多数 NLog 示例都使用某种 NLog 配置文件,但我想要完全可重新配置的编程解决方案,如果您使用纯代码来实现 - 它可能如下所示:

    var conf = new NLog.Config.LoggingConfiguration();
    var consoletarget = new ColoredConsoleTarget() { Layout = "${message}" };

    conf.AddTarget("console", consoletarget);
    //conf.LoggingRules.Add(new LoggingRule("*", NLog.LogLevel.Debug, consoletarget));
    //conf.LoggingRules.Add(new LoggingRule("*", NLog.LogLevel.Info, consoletarget));
    conf.AddRuleForAllLevels(consoletarget);

    NLog.LogManager.Configuration = conf;

    var log = NLog.LogManager.GetLogger("hello");

    log.Trace("trace");
    log.Debug("debug");
    log.Info("info");
    log.Warn("warn");
    log.Error("error");
    log.Fatal("fatal");

我对一些代码进行了注释,以防万一您想重新配置将向最终用户显示的日志级别。 (默认全部显示)