log4net的配置使用详解

log4net是一款优秀的第三方日志框架，可以很容易的加载到开发项目中（引用log4net的dll，再配置些基本参数即可），帮助程序员把日志信息输出到各种不同的目标，常见的有文本、数据库、windows日志、邮件、内存缓冲区等目标。

首先需要log4net的dll（可在NuGet上搜索安装），引用到程序中，然后再配置下配置文件，配置文件如下：

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="log4net" 
             type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
  </configSections>
  <!--站点日志配置部分-->
  <log4net>
    <root>
      <!--控制级别，由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF-->
      <!--比如定义级别为INFO，则INFO级别向下的级别，比如DEBUG日志将不会被记录-->
      <!--如果没有定义LEVEL的值，则缺省为DEBUG-->
      <level value="ERROR"/>
      <appender-ref ref="RollingFileAppender"/>
    </root>
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--日志文件名开头-->
      <file value="c:\Log\TestLog4net.TXT"/>
      <!--多线程时采用最小锁定-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock"/>
      <!--日期的格式，每天换一个文件记录，如不设置则永远只记录一天的日志，需设置-->
      <datePattern value="(yyyyMMdd)"/>
      <!--是否追加到文件,默认为true，通常无需设置-->
      <appendToFile value="true"/>
      <!--变换的形式为日期，这种情况下每天只有一个日志-->
      <!--此时MaxSizeRollBackups和maximumFileSize的节点设置没有意义-->
      <!--<rollingStyle value="Date"/>-->
      <!--变换的形式为日志大小-->
      <!--这种情况下MaxSizeRollBackups和maximumFileSize的节点设置才有意义-->
      <RollingStyle value="Size"/>
      <!--每天记录的日志文件个数，与maximumFileSize配合使用-->
      <MaxSizeRollBackups value="10"/>
      <!--每个日志文件的最大大小-->
      <!--可用的单位:KB|MB|GB-->
      <!--不要使用小数,否则会一直写入当前日志-->
      <maximumFileSize value="2MB"/>
      <!--日志格式-->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
    </appender>
  </log4net>
</configuration>

layout节点的配置说明：

  • %m(message):输出的日志消息；
  • %n(newline):换行；
  • %d(datetime):输出当前语句运行的时刻；
  • %r(runtime):输出程序从运行到执行到当前语句时消耗的毫秒数；
  • %t(threadid):当前语句所在的线程ID ；
  • %p(priority): 日志的当前日志级别；
  • %c(class):当前日志对象的名称；
  • %L：输出语句所在的行号；
  • %F：输出语句所在的文件名；
  • %-10：表示最小长度为10，如果不够，则用空格填充；

其他开发时遇到的问题

1.项目的目标框架为.NET Framework 3.5(或者4) Client Profile时会报出下图错误，改成.NET Framework 3.5(或者4) 即可；

img

2.当configSections节点没有放在configuration节点下的第一个节点时，编译时不会报警告，但运行时不会记日志。这是因为自定义的节点configSections这个必须放在第一个，这是app.config文件的语法规定；
3.对于大量记日志的程序，需注意配置RollingStyle值为Composite，且设置MaxSizeRollBackups（每天记录的日志文件个数）和maximumFileSize（每个日志文件的最大大小）。我以前遇过一次日志过大的问题，有一次版本临时发布就改了一个方法而没有经过测试，造成每天记几十G日志的，几天就把服务器磁盘弄满了。
4.当发现不记日志时，可从两方面调查问题，一是log4net有没有初始化，也就是XmlConfigurator.Configure();二是看level节点的配置是不是正确；
5.当发现一些设置参数没有起作用时，请检查是不是同一个节点被设置过多次，当被重复设置时，log4net会选择最后一个作为实际的设置。例如设置记录日志的级别设置两次如，则最终会以ALL作为记录日志的级别。
6.如果是网站项目，须在项目中的AssemblyInfo.cs文件的最后一行中添加：
[assembly: log4net.Config.DOMConfigurator(ConfigFile = "Web.config", Watch = true)]
7.单独配置log4net.config

log4net.config文件内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
  </configSections>

  <log4net>
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--日志路径(可修改) .\\当前目录-->
      <param name= "File" value= ".\\Log\\"/>
      <!--是否是向文件中追加日志-->
      <param name= "AppendToFile" value= "true"/>
      <!--log保留天数-->
      <param name= "MaxSizeRollBackups" value= "10"/>
      <!--日志文件名是否是固定不变的-->
      <param name= "StaticLogFileName" value= "false"/>
      <!--日志文件名格式为:2008-08-31.log-->
      <param name= "DatePattern" value= "yyyy-MM-dd&quot;.read.log&quot;"/>
      <!--日志根据日期滚动-->
      <param name= "RollingStyle" value= "Date"/>
      <layout type="log4net.Layout.PatternLayout">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n %loggername" />
      </layout>
    </appender>

    <!-- 控制台前台显示日志 -->
    <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
      <mapping>
        <level value="ERROR" />
        <foreColor value="Red, HighIntensity" />
      </mapping>
      <mapping>
        <level value="Info" />
        <foreColor value="Green" />
      </mapping>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%n%date{HH:mm:ss,fff} [%-5level] %m" />
      </layout>

      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="Info" />
        <param name="LevelMax" value="Fatal" />
      </filter>
    </appender>

    <root>
      <!--(高) OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL (低) -->
      <level value="info" />
      <appender-ref ref="ColoredConsoleAppender"/>
      <appender-ref ref="RollingLogFileAppender"/>
    </root>
  </log4net>
</configuration>
7.1 Windows应用程序指定 log4net.config 位置
    class Program
    {
        static void Main(string[] args)
        {
            Directory.SetCurrentDirectory(AppDomain.CurrentDomain.BaseDirectory);
            XmlConfigurator.ConfigureAndWatch(new FileInfo(AppDomain.CurrentDomain.BaseDirectory + "log4net.config"));
        }
    }
7.2 Web程序中指定 log4net.config 位置

img

//已过时[assembly: log4net.Config.DOMConfigurator(ConfigFile = "log4net.config", Watch = true)]
[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", ConfigFileExtension = "config", Watch = true)]//错误
[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", Watch = true)]//正确

XmlConfigurator可配置三个属性：

  1. ConfigFile:配置文件的路径及文件名，包括扩展名，文件相对于程序的根目录。注意：这个属性不能和 ConfigFileExtension 属性同时使用。

  2. ConfigFileExtension:配置文件的后缀名，缺省的文件扩展名为”config”。这个属性不能和 ConfigFile 属性同时使用。

  3. Watch (Boolean属性): 如果为true，log4net框架在运行时监视文件。如果配置文件修改被修改了，将会重新读取。

8、特别注意★★★

配置文件一定要复制到项目生成（运行目录）否则不能生效

img

参阅：

https://blog.csdn.net/pfe_nova/article/details/12225349

http://blog.csdn.net/xssh913913/archive/2007/09/04/1772207.aspx

https://blog.csdn.net/xssh913913/article/details/1772199

posted @ 2021-03-23 15:38  Journey&Flower  阅读(1393)  评论(1)    收藏  举报