使用Log4net記錄日誌

時間  2019-11-11
標籤 使用 log4net log 記錄 日誌 简体版
原文   原文鏈接

  首先說說爲何要進行日誌記錄。在一個完整的程序系統裏面，日誌系統是一個很是重要的功能組成部分。它能夠記錄下系統所產生的全部行爲，並按照某種規範表達出來。咱們可使用日誌系統所記錄的信息爲系統進行排錯，優化系統的性能，或者根據這些信息調整系統的行爲。html

     Log4net是一個很著名的開源的日誌記錄組件。官方網址爲：http://logging.apache.org/log4net/ ，使用Log4net可以很簡單的爲咱們的程序添加日誌記錄功能。下面咱們先經過一個網站例子來講明如何在.net中使用log4net。web

建立日誌記錄步驟

第一步，數據庫

       固然是添加log4net.dll的引用啦，我這裏提供一個log4net的dll文件，懶得去官網下的能夠到這裏下http://www.vdisk.cn/down/index/7509396A7366apache

第二步，windows

       在AssemblyInfo.cs文件中添加下面一句話：緩存

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "Web.config", Watch = true)]

這句話的意思是log4net會自動尋找配置文件App.config或Web.config從而得到並加載其中的配置信息。若是想log4net隨時監視配置文件以便從新加載的話就要這樣寫按照上面同樣寫（winform程序ConfigFile爲App.config）。網絡

第三步，app

      配置Web.config。asp.net

<configuration>
 
  <configSections>
 
        <!--注意：這裏須要添加-->
        <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
   </configSections>
  <connectionStrings>
    <add name="ApplicationServices"
         connectionString="data source=.\SQLEXPRESS;Integrated Security=SSPI;AttachDBFilename=|DataDirectory|\aspnetdb.mdf;User Instance=true"
         providerName="System.Data.SqlClient" />
  </connectionStrings>
 
   
 
   <!--注意：這裏須要添加-->
 
   <log4net>
 
 
        <!--定義輸出到文件中-->
        <appender name="LogFileAppender" type="log4net.Appender.FileAppender">
            <!--定義文件存放位置-->
            <file value="C:\log.txt" />
            <appendToFile value="true" />
            <rollingStyle value="Date" />
            <datePattern value="yyyyMMdd-HH:mm:ss" />
            <layout type="log4net.Layout.PatternLayout">
                <!--輸出格式-->
                <!--樣例：2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
                <conversionPattern value="記錄時間：%date 線程ID:[%thread] 日誌級別：%-5level 出錯類：%logger property:[%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>
 
 
        <!--定義輸出到windows事件中-->
        <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender">
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
            </layout>
        </appender>
 
 
        <!--定義輸出到數據庫中，這裏舉例輸出到Access數據庫中，數據庫爲C盤的log4net.mdb-->
        <appender name="AdoNetAppender_Access" type="log4net.Appender.AdoNetAppender">
            <connectionString value="Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:log4net.mdb" />
            <commandText value="INSERT INTO LogDetails ([LogDate],[Thread],[Level],[Logger],[Message]) VALUES (@logDate, @thread, @logLevel, @logger,@message)" />
            <!--定義各個參數-->
            <parameter>
                <parameterName value="@logDate" />
                <dbType value="String" />
                <size value="240" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%date" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@thread" />
                <dbType value="String" />
                <size value="240" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%thread" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@logLevel" />
                <dbType value="String" />
                <size value="240" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%level" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@logger" />
                <dbType value="String" />
                <size value="240" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%logger" />
                </layout>
            </parameter>
            <parameter>
                <parameterName value="@message" />
                <dbType value="String" />
                <size value="240" />
                <layout type="log4net.Layout.PatternLayout">
                    <conversionPattern value="%message" />
                </layout>
            </parameter>
        </appender>
 
 
        <!--定義日誌的輸出媒介，下面定義日誌以四種方式輸出。也能夠下面的按照一種類型或其餘類型輸出。-->
        <root>
            <!--文件形式記錄日誌-->
            <appender-ref ref="LogFileAppender" />
            <!--控制檯控制顯示日誌-->
            <appender-ref ref="ConsoleAppender" />
            <!--Windows事件日誌-->
            <!--<appender-ref ref="EventLogAppender" />-->
            <!-- 若是不啓用相應的日誌記錄，能夠經過這種方式註釋掉
                <appender-ref ref="AdoNetAppender_Access" />
            -->
        </root>
 
    </log4net>
 
 
  <system.web>
    <compilation debug="true" targetFramework="4.0" />
    <httpModules>
 
      <add name="fileUpload" type="WebApplication3.ProcessFileModule"/>
    </httpModules>
    <authentication mode="Forms">
      <forms loginUrl="~/Account/Login.aspx" timeout="2880" />
    </authentication>
 
    <membership>
      <providers>
        <clear/>
        <add name="AspNetSqlMembershipProvider" type="System.Web.Security.SqlMembershipProvider" connectionStringName="ApplicationServices"
             enablePasswordRetrieval="false" enablePasswordReset="true" requiresQuestionAndAnswer="false" requiresUniqueEmail="false"
             maxInvalidPasswordAttempts="5" minRequiredPasswordLength="6" minRequiredNonalphanumericCharacters="0" passwordAttemptWindow="10"
             applicationName="/" />
      </providers>
    </membership>
 
    <profile>
      <providers>
        <clear/>
        <add name="AspNetSqlProfileProvider" type="System.Web.Profile.SqlProfileProvider" connectionStringName="ApplicationServices" applicationName="/"/>
      </providers>
    </profile>
 
    <roleManager enabled="false">
      <providers>
        <clear/>
        <add name="AspNetSqlRoleProvider" type="System.Web.Security.SqlRoleProvider" connectionStringName="ApplicationServices" applicationName="/" />
        <add name="AspNetWindowsTokenRoleProvider" type="System.Web.Security.WindowsTokenRoleProvider" applicationName="/" />
      </providers>
    </roleManager>
    <httpRuntime maxRequestLength="10240000"/>
  </system.web>
 
  <system.webServer>
    <modules runAllManagedModulesForAllRequests="true"/>
  </system.webServer>
 
</configuration>
View Code

上面這段配置取自周公，配置的說明上面已經註釋的比較詳細了。less

第四步，

在程序中記錄信息。咱們在項目下Default.aspx的Page_Load方法加入以下代碼：

//得到log4net實例
ILog log = log4net.LogManager.GetLogger("LogFileAppender");
log.Info("Default.aspx下面的PageLoad方法被執行");

而後運行項目，能夠發如今c:\log4netfile.txt中已經記錄了一條日誌信息：

記錄時間：2011-04-21 21:26:17,729 線程ID:[4] 日誌級別：INFO  出錯類：LogFileAppender property:[(null)] - 錯誤描述：Default.aspx下面的PageLoad方法被執行

經過上面這幾步我想您已經可以爲程序建立一些簡單日誌記錄功能了。下面咱們再來詳細說說log4net其餘的一些使用方法與特色。

log4net詳細說明

    這裏我經過問答的形式來講明log4net的一些應用。

1.log4net總共有幾種記錄方式，每種方式該如何配置與使用？

Log4net目前支持的輸出方式包括：

1 AdoNetAppender
 
      將日誌記錄到數據庫中。能夠採用SQL和存儲過程兩種方式。
 
2 AnsiColorTerminalAppender
 
      在ANSI 窗口終端寫下高亮度的日誌事件。
 
3 AspNetTraceAppender
 
      能用asp.net中Trace的方式查看記錄的日誌。
 
4 BufferingForwardingAppender
 
      在輸出到子Appenders以前先緩存日誌事件。
 
5 ConsoleAppender
 
      將日誌輸出到控制檯。
 
6 EventLogAppender
 
      將日誌寫到Windows Event Log.
 
7 FileAppender
 
      將日誌寫到文件中。
 
8 LocalSyslogAppender
 
      將日誌寫到local syslog service (僅用於UNIX環境下).
 
9 MemoryAppender
 
      將日誌存到內存緩衝區。
 
10 NetSendAppender
 
      將日誌輸出到Windows Messenger service.這些日誌信息將在用戶終端的對話框中顯示。
 
11 RemoteSyslogAppender
 
      經過UDP網絡協議將日誌寫到Remote syslog service。
 
12 RemotingAppender
 
      經過.NET Remoting將日誌寫到遠程接收端。
 
13 RollingFileAppender
 
      將日誌以回滾文件的形式寫到文件中。
 
14 SmtpAppender
 
      將日誌寫到郵件中。
 
15 TraceAppender
 
      將日誌寫到.NET trace 系統。
 
16 UdpAppender
 
      將日誌connectionless UDP datagrams的形式送到遠程宿主或以UdpClient的形式廣播。

 

能夠看到目前支持的方式仍是不少的，我這裏調幾個認爲經常使用的作個例子。

　　1.文件的方式咱們上面已經講過了，這裏再也不作例子了。

　　2.數據庫方式：

  　　首先，添加數據庫記錄appender

<appender name="AdoNetAppender_Access" type="log4net.Appender.AdoNetAppender">
        <!--數據庫鏈接字符串-->
        <connectionString value="Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:log4net.mdb" />
        <commandText value="INSERT INTO LogDetails ([LogDate],[Thread],[Level],[Logger],[Message]) VALUES (@logDate, @thread, @logLevel, @logger,@message)" />
        <!--定義各個參數-->
        <parameter>
            <parameterName value="@logDate" />
            <dbType value="String" />
            <size value="240" />
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%date" />
            </layout>
        </parameter>
        <parameter>
            <parameterName value="@thread" />
            <dbType value="String" />
            <size value="240" />
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%thread" />
            </layout>
        </parameter>
        <parameter>
            <parameterName value="@logLevel" />
            <dbType value="String" />
            <size value="240" />
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%level" />
            </layout>
        </parameter>
        <parameter>
            <parameterName value="@logger" />
            <dbType value="String" />
            <size value="240" />
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%logger" />
            </layout>
        </parameter>
        <parameter>
            <parameterName value="@message" />
            <dbType value="String" />
            <size value="240" />
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%message" />
            </layout>
        </parameter>
    </appender>

而後創建c:log4net.mdb 數據庫，並在代碼中啓用數據庫記錄方式：

//得到log4net實例
ILog log = log4net.LogManager.GetLogger("AdoNetAppender_Access");
log.Debug("Default.aspx下面的PageLoad方法被執行");

這樣日誌就被記錄到數據庫中了。

2.log4net如何過濾我想要的日誌信息，好比一個日誌中只記錄程序錯誤日誌?

這個需求能夠經過配置filter來實現。具體操做以下：

    全局方式：

    這種方式會將級別應用於全部的日誌輸入方式。具體操做爲在root節點下添加：

<!--控制級別，由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF
    好比定義級別爲INFO，則INFO級別向下的級別，好比DEBUG日誌將不會被記錄
-->
<!--若是沒有定義LEVEL的值，則缺省爲DEBUG-->
<level value="ERROR" />

這樣對於全部的日誌記錄方式，全部地域ERROR級別的都不會被記錄了。

     單獨配置級別方式：

      該方式不會影響其餘的日誌輸入方式。方法以下爲，在具體的appender下添加filter：

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

這種方式能夠配置記錄級別的方位，若是隻須要記錄一種，則最大和最小設置同樣就好了。

3.你上面的日誌輸出格式我不喜歡，如何在log4net中配置我想要的日誌輸出格式？

log4net的輸入格式定義在每一個appender的layout中。具體的有如下內置可選項：

%m(message):輸出的日誌消息，如ILog.Debug(…)輸出的一條消息 
%n(new line):換行 
%d(datetime):輸出當前語句運行的時刻 
%r(run time):輸出程序從運行到執行到當前語句時消耗的毫秒數 
%t(thread id):當前語句所在的線程ID 
%p(priority): 日誌的當前優先級別，即DEBUG、INFO、WARN…等 
%c(class):當前日誌對象的名稱，例如： 
%f(file):輸出語句所在的文件名。 
%l(line)：輸出語句所在的行號。 
%數字：表示該項的最小長度，若是不夠，則用空格填充，如「%-5level」表示level的最小寬度是5個字符，若是實際長度不夠5個字符則以空格填充。

經過這些東西，你能夠任意組合你喜歡的輸出格式內容。

4.有沒有方式控制程序自動按日期記錄日誌信息，即天天的日誌都在不一樣的日誌文件中？

其實這種方式對應於一種特定的記錄方式：RollingFileAppender。這種方式也是基於文件記錄的，不過他提供更加靈活的日誌記錄方式。具體說來他能夠按日誌文件的大小或者日誌記錄的時間進行自動變換日誌文件。

按天天不一樣的日期進行記錄分類：

<appender name="RollingLogFileAppenderEveryMin" type="log4net.Appender.RollingFileAppender">
 
<!--日誌文件名開頭-->
 
<file value="c:\logfile.txt" />
 
<!--是否追加到文件-->
 
<appendToFile value="true" />
 
<!--變換的形式爲日期-->
 
<rollingStyle value="Date" />
 
<!--日期的格式，每分鐘換一個文件記錄-->
 
<datePattern value="yyyyMMdd-HHmm" />
 
<layout type="log4net.Layout.PatternLayout">
 
<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
 
</layout>
 
</appender>

按照日誌文件的大小進行變換，經過這種方式能夠有效下降日誌文件體積膨脹的問題：

<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
 
<!--日誌文件名-->
 
<file value="c:\log.txt"/>
 
<!--是否在文件中追加-->
 
<appendToFile value="true"/>
 
<!--按照文件的大小進行變換日誌文件-->
 
<rollingStyle value="Size"/>
 
<!--最大變換數量，若是超過這個數量則從第一個文件開始複寫-->
 
<maxSizeRollBackups value="10"/>
 
<!--最大文件大小，支持KB,MB,GB-->
 
<maximumFileSize value="100KB"/>
 
<!--日誌文件名是否爲靜態-->
 
<staticLogFileName value="true"/>
 
<layout type="log4net.Layout.PatternLayout">
 
<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline"/>
 
</layout>
 
</appender>

最後從網上找了一段寫日誌的原則，感受仍是很好的：

【寫日誌的原則】

Ⅰ.在catch後,把異常寫入日誌.

Ⅱ.在調用第三方控件的開始和結束處.

Ⅲ.在鏈接數據庫的開始結束處.

Ⅳ.除非必要,不要在循環體中加入日誌,不然一旦出問題可能致使日誌暴增.

Ⅴ.在本身認爲很重要的邏輯處寫入日誌.

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程