【log4net】配置文件解释

2022-09-24 10:23:26

ASP.NET MVC

1、web.config：

<configSections>

    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />

</configSections>

<log4net>

  <root>

    <!-- 定义记录的日志级别，None>Fatal>Error>Warn>Debug>Info-->

    <!--级别的定义要注意,如果你定义DEBUG,那么低于DEBUG级别以下的信息,将不会记入日志,

    啥意思呢?就是说,就算你在程序里,用log.info()来写入一个日志信息,可是你在配置中指定level为DEBUG,

    由于INFO级别低于DEBUG,所以,不会被记入日志.这样的处理非常灵活-->

    <priority value="ALL" />

    <!-- 日志记录到什么【RollingFileAppender】介质中-->

    <appender-ref ref="RollingFileAppender" />

  </root>

  <!--TraceAppender将日志信息写入System.Diagnostics.Trace系统（出现在输出窗口）-->

  <appender name="TraceAppender" type="log4net.Appender.TraceAppender">

    <layout type="log4net.Layout.PatternLayout">

      <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

  </appender>

  <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">

    <layout type="log4net.Layout.PatternLayout">

      <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

  </appender>

  <!-- name属性指定其名称,type则是log4net.Appender命名空间的一个类的名称,意思是,指定使用哪种介质-->

  <!--appender节点中，type=RollingFileAppender 的意思是将日志以回滚文件的形式写到文件中。-->

  <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">

    <!--输出到什么目录-->

    <file value="log\\log.txt" />

    <param name="Encoding" value="UTF-8" />

    <!--AppendToFile节点规定了是否覆写到文件中。假设我们已经有了一个20180705.txt日志文件，当为true的时候，日志文件会附加到这个文件上。为false的时候，Log4Net会先将原来的日志文件备份-->

    <appendToFile value="true" />

    <!-- 备份文件的个数,大于这个数字，会自动删除较早的备份文件-->

    <maxSizeRollBackups value="" />

    <!-- 单个文件大小。我们可以使用"KB", "MB" 或 "GB"为 MaxFileSize 作为后缀限定大小。默认的文件大小是10MB。-->

    <maximumFileSize value="3000KB" />

    <!--RollingStyle是文件创建的方式。上例中市设置为以Date方式创建新文件。或者Size-->

    <rollingStyle value="Size" />

    <!-- DatePattern 日期格式，当我们设置了RollingStyle 为Date方式后，Log4Net会自动使用DatePattern 中的日期格式来创建新的日志文件-->

    <param name="DatePattern" value="yyyyMMdd&quot;.txt&quot;" />

    <!-- 是否使用静态文件名，如果rollingStyle设置为Date，这里就是false-->

    <staticLogFileName value="true" />

    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

    <!--日志输出布局样式-->

    <layout type="log4net.Layout.PatternLayout">

      <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

  </appender>

</log4net>

2.global.asax ：

       protected void Application_Start()

        {

            log4net.Config.XmlConfigurator.Configure();

        }

3.调用：

 private readonly ILog _log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

     _log.Info("日志开启");

第二种方式：

1.配置文件log4net.config

<log4net>

  <root>

    <!-- 定义记录的日志级别，None>Fatal>Error>Warn>Debug>Info-->

    <!--级别的定义要注意,如果你定义DEBUG,那么低于DEBUG级别以下的信息,将不会记入日志,

    啥意思呢?就是说,就算你在程序里,用log.info()来写入一个日志信息,可是你在配置中指定level为DEBUG,

    由于INFO级别低于DEBUG,所以,不会被记入日志.这样的处理非常灵活-->

    <priority value="ALL" />

    <!-- 日志记录到什么【RollingFileAppender】介质中-->

    <appender-ref ref="RollingFileAppender" />

  </root>

  <!--TraceAppender将日志信息写入System.Diagnostics.Trace系统（出现在输出窗口）-->

  <appender name="TraceAppender" type="log4net.Appender.TraceAppender">

    <layout type="log4net.Layout.PatternLayout">

      <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

  </appender>

  <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">

    <layout type="log4net.Layout.PatternLayout">

      <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

  </appender>

  <!-- name属性指定其名称,type则是log4net.Appender命名空间的一个类的名称,意思是,指定使用哪种介质-->

  <!--appender节点中，type=RollingFileAppender 的意思是将日志以回滚文件的形式写到文件中。-->

  <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">

    <!--输出到什么目录-->

    <file value="log\\log.txt" />

    <param name="Encoding" value="UTF-8" />

    <!--AppendToFile节点规定了是否覆写到文件中。假设我们已经有了一个20180705.txt日志文件，当为true的时候，日志文件会附加到这个文件上。为false的时候，Log4Net会先将原来的日志文件备份-->

    <appendToFile value="true" />

    <!-- 备份文件的个数,大于这个数字，会自动删除较早的备份文件-->

    <maxSizeRollBackups value="" />

    <!-- 单个文件大小。我们可以使用"KB", "MB" 或 "GB"为 MaxFileSize 作为后缀限定大小。默认的文件大小是10MB。-->

    <maximumFileSize value="2KB" />

    <!--RollingStyle是文件创建的方式。上例中市设置为以Date方式创建新文件。或者Size-->

    <rollingStyle value="Size" />

    <!-- DatePattern 日期格式，当我们设置了RollingStyle 为Date方式后，Log4Net会自动使用DatePattern 中的日期格式来创建新的日志文件-->

    <param name="DatePattern" value="yyyyMMdd&quot;.txt&quot;" />

    <!-- 是否使用静态文件名，如果rollingStyle设置为Date，这里就是false-->

    <staticLogFileName value="true" />

    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

    <!--日志输出布局样式-->

    <layout type="log4net.Layout.PatternLayout">

      <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

  </appender>

</log4net>

2.Gloabal.asax.cs中初始化

  public class WebApiApplication : System.Web.HttpApplication

    {

        protected void Application_Start()

        {

            log4net.Config.XmlConfigurator.ConfigureAndWatch(new System.IO.FileInfo(AppDomain.CurrentDomain.BaseDirectory + "log4net.config"));

        }

    }

3.调用

 public class HomeController

 {

    private ILog _logger = LogManager.GetLogger(typeof(HomeController));

    _logger.info("日志");

 }

ASP.NET Core

startup中配置

  public IConfiguration Configuration { get; }

  private readonly AppConfigurations _appConfigurations;

  public static ILoggerRepository repository { get; set; }

  public Startup(IConfiguration configuration)

  {

      Configuration = configuration;

      repository = LogManager.CreateRepository("NetCoreLogRepository");

      XmlConfigurator.Configure(repository, new FileInfo("log4net.config"));

  }

HomeController中调用

public class HomeController: Controller

    {

        private ILog _log = LogManager.GetLogger(Startup.repository.Name, typeof(TransactionManagementController));

        [HttpGet]

        public JsonResult GetStudentList()

        {

            _log.Info("日志记录");return null;

        }

    }

Log4Net中配置文件的解释

<log4net>

  <!-- 错误日志类-->

  <logger name="logerror">

    <level value="ALL" />

    <appender-ref ref="ErrorAppender" />

  </logger>

  <!-- 信息日志类 -->

  <logger name="loginfo">

    <level value="ALL" />

    <appender-ref ref="InfoAppender" />

  </logger>

  <!-- 错误日志附加介质-->

  <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">

    <param name="File" value="Log\\LogError\\" />

    <param name="AppendToFile" value="true" />

    <param name="MaxSizeRollBackups" value="" />

    <param name="MaxFileSize" value="" />

    <param name="StaticLogFileName" value="false" />

    <param name="DatePattern" value="yyyyMMdd&quot;.htm&quot;" />

    <param name="RollingStyle" value="Date" />

    <!--布局-->

    <layout type="log4net.Layout.PatternLayout">

      <param name="ConversionPattern" value="&lt;HR COLOR=red&gt;%n异常时间：%d [%t] &lt;BR&gt;%n异常级别：%-5p &lt;BR&gt;%n异 常 类：%c [%x] &lt;BR&gt;%n%m &lt;BR&gt;%n &lt;HR Size=1&gt;"  />

    </layout>

  </appender>

  <!-- 信息日志附加介质-->

  <appender name="InfoAppender" type="log4net.Appender.RollingFileAppender">

    <param name="File" value="Log\\LogInfo\\" />

    <param name="AppendToFile" value="true" />

    <param name="MaxFileSize" value="" />

    <param name="MaxSizeRollBackups" value="" />

    <param name="StaticLogFileName" value="false" />

    <param name="DatePattern" value="yyyyMMdd&quot;.htm&quot;" />

    <param name="RollingStyle" value="Date" />

    <!-- 信息日志布局-->

    <layout type="log4net.Layout.PatternLayout">

      <param name="ConversionPattern" value="&lt;HR COLOR=blue&gt;%n日志时间：%d [%t] &lt;BR&gt;%n日志级别：%-5p &lt;BR&gt;%n日 志 类：%c [%x] &lt;BR&gt;%n%m &lt;BR&gt;%n &lt;HR Size=1&gt;"  />

    </layout>

  </appender>

</log4net>

先不分析上面这段配置信息是什么意思。我们先来回想一下我们的日志类通常用来做什么，假设我们有一个库存管理系统，分为两大模块，一个是出库，一个是入库。我们可能想要出库的相关信息保存在某一个文件夹里面，入库的信息存在另一个文件夹里面。这样，我们通常的做法是用在日志类中不同的路径将日志写到不同位置，但是如果我们不单单想要写到日志文件中，而且想要将这些日志文件插入数据库呢？一般来讲，我们会再建立一些方法，来写到数据库。另外，正常日志信息和错误日志信息的布局，我们可能想要根据日志类型的不同，改变信息的布局，比如错误日志里面有异常信息的记录，正常日志里面就没有异常的记录。

总结地说，我们的日志类的需求通常就是：1、能够按要求将日志写到不同的介质上（文件、数据库、邮件等）；2、能够根据日志类型的不同，写到不同的位置；3、能根据信息的类型，改变日志的布局。

不得不说，想要写好一个日志记录类还是挺不容易的的，看是简单的需求要做好，也是需要下大工夫的。而这些在Log4Net中，只需要经过一些配置，就可以完成。如果你懒得写配置信息，也可以直接将上面的配置信息拷过去用。

配置文件中节点的解释

logger是负责日志的记录者，假设我们需要记录一些正常的运行时日志和出现异常时的错误日志，那么我们可以通过在配置文件当中添加两个Logger实现。
appender提供记录的介质，前面谈到，我们可能要同时将数据记录到文件和数据库中，我们可以简单地通过编写appender实现，而且Log4Net当中已经默认提供了一些常用的appender，我们可以简单地修改一些配置文件就实现同时向数据库和同时向文件中写入的功能。

layout负责把记入的内容格式化。其实就是决定日志文件要长什么样子。

Logger节点的解释

以错误日志类为例进行解释

<!-- 错误日志类-->

  <logger name="logerror">              <!-- 日志类的名字-->

    <level value="ALL" />               <!-- 定义记录的日志级别-->

    <appender-ref ref="ErrorAppender" /><!-- 记录到什么介质中-->

  </logger>

level定义记录的日志级别,就是说,你要记录哪个级别以上的日志,级别由高往低依次是:

None

Fatal

ERROR

WARN

DEBUG

INFO

ALL

级别的定义要注意,如果你定义DEBUG,那么低于DEBUG级别以下的信息,将不会记入日志,啥意思呢?就是说,就算你在程序里,用log.info()来写入一个日志信息,可是你在配置中指定level为DEBUG,由于INFO级别低于DEBUG,所以,不会被记入日志.这样的处理非常灵活

appender-ref定义日志要写入到什么介质中中。上面例子中就是写入到ErrorAppender这个介质中，在ErrorAppender节点我们可以定义跟日志有关的要写入到什么地方，日志文件的格式是什么等信息。

appender节点的解释

以ErrorAppender为例

<!-- 错误日志附加介质-->

  <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">  <!-- name属性指定其名称,type则是log4net.Appender命名空间的一个类的名称,意思是,指定使用哪种介质-->

    <param name="File" value="Log\\LogError\\" /> <!-- 输出到什么目录-->

    <param name="AppendToFile" value="true" /><!-- 是否覆写到文件中-->

    <param name="MaxSizeRollBackups" value="" /><!-- 备份文件的个数-->

    <param name="MaxFileSize" value="10MB" /><!-- 单个日志文件最大的大小-->

    <param name="StaticLogFileName" value="false" /><!-- 是否使用静态文件名-->

    <param name="DatePattern" value="yyyyMMdd&quot;.txt&quot;" /><!-- 日志文件名-->

    <param name="RollingStyle" value="Date" />

    <!--布局-->

    <layout type="log4net.Layout.PatternLayout">

      <param name="ConversionPattern" value="&lt;HR COLOR=red&gt;%n异常时间：%d [%t] &lt;BR&gt;%n异常级别：%-5p &lt;BR&gt;%n异 常 类：%c [%x] &lt;BR&gt;%n%m &lt;BR&gt;%n &lt;HR Size=1&gt;"  />

    </layout>

  </appender>

appender节点中，type=RollingFileAppender 的意思是将日志以回滚文件的形式写到文件中。

File节点中规定了文件要写入到什么目录中，上例中的“Log\\LogError\\”代表写入到“程序输入目录（Debug目录）\Log\LogError\”文件夹中。

AppendToFile节点规定了是否覆写到文件中。假设我们已经有了一个20131028.htm日志文件，当为true的时候，日志文件会附加到这个文件上。为false的时候，Log4Net会先将原来的日志文件备份，生成一个新的日志文件）。

MaxFileSize 最大的文件大小。我们可以使用"KB", "MB" 或 "GB"为 MaxFileSize 作为后缀限定大小。默认的文件大小是10MB。

RollingStyle是文件创建的方式。上例中市设置为以Date方式创建新文件。

DatePattern 日期格式，当我们设置了RollingStyle 为Date方式后，Log4Net会自动使用DatePattern 中的日期格式来创建新的日志文件。

MaxSizeRollBackups这个属性用来设置，当日志文件达到MaxFileSize大小（设置2KB），大于2kb就自动创建备份文件。备份文件的多少由MaxSizeRollBackups决定。

如果MaxSizeRollBackups设置为6，当备份文件大于6时会把最早日期的自动删掉

StaticLogFileName 是否采用静态文件名。因为我们这个例子是采用以日期作为文件名，每天的日志文件的名字都是动态的，所以上例中为false。如果采用静态文件名，那么日志文件的名字就是唯一确定的。可以参考下面的配置文件进行设置。下面的配置文件中就是采用静态文件名，生成的日志文件名都是log.txt。

<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">

    <file value="log.txt" />

    <appendToFile value="true" />

    <rollingStyle value="Size" />

    <maxSizeRollBackups value="" />

    <maximumFileSize value="100KB" />

    <staticLogFileName value="true" />

    <layout type="log4net.Layout.PatternLayout">

        <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />

    </layout>

</appender>

layout就是布局。Layout中的ConversionPattern就是日志文件的格式，一些符号的介绍附加在下面。由于格式化的方式比较多，除了下面介绍的，大家也可以自己看看官方文档。

%m[%message]	输出的日志消息
%n	换行
%d[%datetime]	输出当前语句运行的时刻
%r	输出程序从运行到执行到当前语句时消耗的毫秒数
%d	当前语句所在的线程ID
%p	日志的当前优先级别
%c	当前日志对象的名称
%L	输出语句所在的行号
%F	输出语句所在的文件名
%-数字	表示该项的最小长度，如果不够，则用空格填充

参考链接：

Log4Net五步走

Apache log4net™ Config Examples

Apache log4net� SDK Documentation

码农公寓