从代码中使用XML配置log4net或NLog

时间:2010-11-30 18:42:00

标签: logging log4net nlog

最近,我一直致力于一个项目,除此之外,我们还想提供一个集中配置系统。我们使用WCF,Silverlight,C#等来创建分布式服务和客户端系统。我们要配置的一件事是记录。显然,我们可以通过app.config或单独的日志配置文件配置log4net或NLog。我们也可以通过代码配置。我想看看是否可以通过代码从XML进行配置。换句话说,假设您在内存中(可能从数据库中读取?)配置任一日志框架所需的整个XML。可以吗?是否可以通过包含正确形成的字符串(在特定日志框架的上下文中)配置log4net和/或NLog,而不是从文件读取或通过“常规”API配置?

我已经想出了如何为每个这些日志框架做到这一点。我不确定我们是否真的会使用它,但我认为我会在这里分享它,以防万一其他人可能会发现它有用。另外,请随意评论以这种方式配置日志框架的可行性(或不可信)。

我能想到的两个明显的潜在问题是:

  1. 构建有效的XML(或在数据库中输入)可能很困难。我的第一个猜测是,人们将以与今天相同的方式定义XML。将它放在app.config(或外部配置)文件中,然后运行测试程序以验证XML是否产生预期结果。

  2. 更新数据库中的XML然后让程序/服务/对更改作出反应(比如使用log4net的ConfigureAndWatch选项)是多么容易或困难(或不可能)?我对程序或服务如何知道XML已更新的机制不感兴趣。我们假设程序将定期检查数据库。给定一个新的XML字符串,很容易重新配置日志框架。

  3. 我会发布我的技巧作为这个问题的答案。

1 个答案:

答案 0 :(得分:9)

在代码中通过XML配置log4net:

  string xml =
  @"<log4net>
    <appender name='file1' type='log4net.Appender.RollingFileAppender'>
      <!-- Log file locaation -->
      <param name='File' value='log4net.log'/>
      <param name='AppendToFile' value='true'/>
      <!-- Maximum size of a log file -->
      <maximumFileSize value='2KB'/>
      <!--Maximum number of log file -->
      <maxSizeRollBackups value='8'/>
      <!--Set rolling style of log file -->
      <param name='RollingStyle' value='Composite'/>
      <param name='StaticLogFileName' value='false'/>
      <param name='DatePattern' value='.yyyy-MM-dd.lo\g'/>
      <layout type='log4net.Layout.PatternLayout'>
        <param name='ConversionPattern' value='%d [%t] %-5p  %m%n'/>
      </layout>
    </appender>

    <!-- Appender layout fix to view in console-->
    <appender name='console' type='log4net.Appender.ConsoleAppender'>
      <layout type='log4net.Layout.PatternLayout'>
        <param name='Header' value='[Header]\r\n'/>
        <param name='Footer' value='[Footer]\r\n'/>
        <param name='ConversionPattern' value='%d [%t] %-5p  %m%n'/>
      </layout>
    </appender>

    <appender name='debug' type='log4net.Appender.DebugAppender'>
      <layout type='log4net.Layout.PatternLayout'>
        <param name='ConversionPattern' value='%d [%t] %logger %-5p %m%n'/>
      </layout>
    </appender>
    <root>
      <level value='INFO'/>
      <!--
            Log level priority in descending order:

            FATAL = 1 show  log -> FATAL 
            ERROR = 2 show  log -> FATAL ERROR 
            WARN =  3 show  log -> FATAL ERROR WARN 
            INFO =  4 show  log -> FATAL ERROR WARN INFO 
            DEBUG = 5 show  log -> FATAL ERROR WARN INFO DEBUG
            -->
      <!-- To write log in file -->
      <appender-ref ref='debug'/>
      <appender-ref ref='file1'/>
    </root>

  </log4net>";

  XmlDocument doc = new XmlDocument();
  doc.LoadXml(xml);

  log4net.Config.XmlConfigurator.Configure(doc.DocumentElement);

在代码中通过XML配置NLog(适用于NLog 2.0及更高版本):

  string xml = @"<nlog> 
                   <targets> 
                     <target name='console' type='Console' layout='${message}' /> 
                   </targets> 

                   <rules> 
                     <logger name='*' minlevel='Error' writeTo='console' /> 
                   </rules> 
                 </nlog>"; 

  StringReader sr = new StringReader(xml); 
  XmlReader xr = XmlReader.Create(sr); 
  XmlLoggingConfiguration config = new XmlLoggingConfiguration(xr, null); 
  LogManager.Configuration = config; 
  //NLog is now configured just as if the XML above had been in NLog.config or app.config

在NLog 2.0之前,NLog的XmlLoggingConfiguration对象不在其构造函数中使用XmlReader。您可以改为传递XmlElement,如下所示:

  string xml = @"<nlog>  
               <targets>  
                 <target name='debugger' type='Console' layout='${message}' />  
               </targets>  

               <rules>  
                 <logger name='*' minlevel='Error' writeTo='console' />  
               </rules>  
             </nlog>";

  XmlDocument doc = new XmlDocument();
  doc.LoadXml(xml);

  XmlLoggingConfiguration config = new XmlLoggingConfiguration(doc.DocumentElement,null);
  LogManager.Configuration = config;

要更新配置,给定一个新的XML字符串,只需重复您正在使用的特定日志记录框架的步骤。