ASP.NET MVC 使用 Log4net 記錄日誌

来源:https://www.cnblogs.com/wubh/archive/2018/08/20/9506009.html
-Advertisement-
Play Games

Log4net 介紹 Log4net 是 Apache 下一個開放源碼的項目，它是Log4j 的一個克隆版。我們可以控制日誌信息的輸出目的地。Log4net中定義了多種日誌信息輸出模式。它可以根據需要將日誌輸出到控制台，文本文件，windows 日誌事件查看器中，包括資料庫，郵件等等位置，以便我們快 ...


Log4net 介紹

Log4net 是 Apache 下一個開放源碼的項目，它是Log4j 的一個克隆版。我們可以控制日誌信息的輸出目的地。Log4net中定義了多種日誌信息輸出模式。它可以根據需要將日誌輸出到控制台，文本文件，windows 日誌事件查看器中，包括資料庫，郵件等等位置，以便我們快速跟蹤程式bug。

Log4net 提供 7個日誌等級，從高到底分別為：OFF > FATAL > ERROR > WARN > INFO > DEBUG  > ALL

Log4net 有 3個主要的成員， loggers ，appenders 和 layouts 。 

  • Logger 介紹
    Logger是負責日誌的記錄者，假設我們需要記錄一些正常的運行時日誌和出現異常時的錯誤日誌，那麼我們可以通過在配置文件當中添加兩個Logger實現。Logger主要用於記錄日誌的分類和控制日誌的級別。它可以以多種格式輸出日誌信息，同時它也可以控制日誌的輸出級別。 log4net使用繼承體系，也就是說假如存在兩個Logger，名字分別為a.b.c和a.b。那麼a.b就是a.b.c的祖先。每個Logger都繼承了它祖先的屬性
  • Appender 介紹
    提供日誌記錄的輸出源，我們可以將日誌輸出到控制台，文本文件， windows 日誌事件查看器中（ 在Window日誌>應用程式 中查看），資料庫，郵件等。這些輸出源都是通過 Appender 來配置實現。
    不建議將日誌文件保存到資料庫中，因為使用 sql 去排查日誌還是比較困難的，最好是將日誌文件保存的日誌管理服務或Elasticsearch，該服務可以提供良好的全文索引以及其他功能。
  • Layout 介紹
    Layout 用於控制 Appender 的輸出格式。
    Layout 中 PatternLayout 約定的字元串轉換解釋
        %m、%message         輸出的日誌消息
    %d、%datetime        輸出當前語句運行的時刻，格式%date{yyyy-MM-dd HH:mm:ss,fff}
    %r、%timestamp       輸出程式從運行到執行到當前語句時消耗的毫秒數
    %p、%level           日誌的當前優先順序別
    %c、%logger          當前日誌對象的名稱
    %L、%line            輸出語句所在的行號
    %F、%file            輸出語句所在的文件名，警告：只在調試的時候有效，調用本地信息會影響性能
    %a、%appdomain       引發日誌事件的應用程式域的名稱。
    %C、%class、%type    引發日誌請求的類的全名，警告：會影響性能
    %exception           異常信息
    %u、%identity        當前活動用戶的名字，我測試的時候%identity返回都是空的。警告：會影響性能
    %l、%location        引發日誌事件的名空間、類名、方法、行號。警告：會影響性能，依賴pdb文件
    %M、%method          發生日誌請求的方法名，警告：會影響性能
    %n、%newline         換行符
    %x、%ndc             NDC(nested diagnostic context)
    %X、%mdc、%P、%properties  等介於 %property
    %property           輸出{log4net:Identity=, log4net:UserName=, log4net:HostName=} 
    %t、%thread         引發日誌事件的線程，如果沒有線程名就使用線程號。
    %w、%username       當前用戶的WindowsIdentity,類似：HostName/Username。警告：會影響性能
    %utcdate            發生日誌事件的UTC時間。例如：%utcdate{HH:mm:ss,fff}
    %%                  輸出一個百分號

    更多內容請參考：http://logging.apache.org/log4net/release/sdk/html/T_log4net_Layout_PatternLayout.htm

如何使用

以 ASP.NET MVC 項目為例

 1.使用 Nuget 安裝 log4net ，

PM> Install-Package log4net

2.創建 log4net.config 配置文件 ，並且將該文件的屬性“複製到輸出目錄”修改為 “始終複製”

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net-net-2.0"/>
  </configSections>
  <log4net>
    <root>
      <level value="ALL" />
      <appender-ref ref="LogFileAppender" />
      <!--<appender-ref ref="EventLogAppender" />-->
    </root>
    <!--定義輸出到文件-->
    <appender name ="LogFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--定義文件存放位置-->
      <param name="File" value ="App_Data\"/>
      <param name="AppendToFile" value="true" />
      <param name="MaxSizeRollBackups" value="100" />
      <param name="MaxFileSize" value="10240" />
      <param name="StaticLogFileName" value="false" />
      <!--文件名格式-->
      <param name="DatePattern" value="yyyy.MM.dd'.txt'" />
      <param name="RollingStyle" value ="Date" />
      <!--不以獨占方式記錄日誌,僅在記錄每個日誌的最短時間內鎖定,因為部署到伺服器上遇到了文件被占用無法下載日誌-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <layout type="log4net.Layout.PatternLayout">
        <!--定義輸出格式-->
        <!--示例 2018-08-20 12:10:49,348 -線程ID:[21] 日誌級別:[INFO ] : [日誌信息]-->
        <param name="ConversionPattern" value="%date 線程ID:[%thread] 日誌級別:[%-5level] : [%message]%newline"/>
      </layout>
      <!--過濾級別 FATAL > ERROR > WARN > INFO > DEBUG-->
      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="DEBUG" />
        <param name="LevelMax" value="FATAL" />
      </filter>
    </appender>
    <!--定義輸出到 windows 事件中-->
    <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline"></conversionPattern>
      </layout>
    </appender>
  </log4net>
</configuration>

3.創建 LogHelper 類，提供日誌記錄的方法

public class LogHelper
    {
        private ILog _log4Net = null;
        private const string DEFAULT_LOGGER_NAME = "Logger";
        /// <summary>
        /// Prevents a default instance of the <see cref="LogWriter"/> class from being created.
        /// </summary>
        /// <param name="log4NetInstance">The log4net instance to be used.</param>
        private LogHelper(ILog log4NetInstance)
        {
            _log4Net = log4NetInstance;
        }

        /// <summary>
        /// Gets a logger with the specified configuration name.
        /// </summary>
        /// <param name="configName">Name of the logger in the configuration.</param>
        /// <returns>The logger obtained.</returns>
        /// <exception cref="System.Configuration.ConfigurationException">Thrown when no logger with the specified configuration name was found.</exception>
        public static LogHelper GetLogger(string configName)
        {
            var logger = LogManager.GetLogger(configName);
            if (logger == null)
            {
                throw new ArgumentException(string.Format("No logger configuration named '{0}' was found in the configuration.", configName), "configName");
            }
            return new LogHelper(logger);
        }

        /// <summary>
        /// Gets the default.
        /// </summary>
        public static LogHelper Default
        {
            get
            {
                return GetLogger(DEFAULT_LOGGER_NAME);
            }
        }

        /// <summary>
        /// Writes an information level logging message.
        /// </summary>
        /// <param name="message">The message to be written.</param>
        public void WriteInfo(object message)
        {
            _log4Net.Info(message);
        }

        /// <summary>
        /// Writes a warning level logging message.
        /// </summary>
        /// <param name="message">The message to be written.</param>
        public void WriteWarning(object message)
        {
            _log4Net.Warn(message);
        }

        /// <summary>
        /// Writes a warning level logging message.
        /// </summary>
        /// <param name="message">The message to be written.</param>
        /// <param name="exception">The exception.</param>
        public void WriteWarning(object message, System.Exception exception)
        {
            _log4Net.Warn(message, exception);
        }

        /// <summary>
        /// Writes the error.
        /// </summary>
        /// <param name="message">The message to be written.</param>
        public void WriteError(object message)
        {
            _log4Net.Error(message);
        }

        /// <summary>
        /// Writes the error level logging message..
        /// </summary>
        /// <param name="message">The message to be written.</param>
        /// <param name="exception">The exception.</param>
        public void WriteError(object message, System.Exception exception)
        {
            _log4Net.Error(message, exception);
        }

        /// <summary>
        /// Writes the fatal error level logging message..
        /// </summary>
        /// <param name="message">The message to be written.</param>
        public void WriteFatal(object message)
        {
            _log4Net.Fatal(message);
        }

        /// <summary>
        /// Writes the fatal error level logging message..
        /// </summary>
        /// <param name="message">The message to be written.</param>
        /// <param name="exception">The exception.</param>
        public void WriteFatal(object message, System.Exception exception)
        {
            _log4Net.Fatal(message, exception);
        }

        public void DeleteLog()
        {
            string logDirPath = Path.Combine(Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location), "Log");
            if (!Directory.Exists(logDirPath)) return;
            int days = 30;
            foreach (string filePath in Directory.GetFiles(logDirPath))
            {
                DateTime dt;
                DateTime.TryParse(Path.GetFileNameWithoutExtension(filePath).Replace(@"Log\", "").Replace(".", "-"), out dt);
                if (dt.AddDays(days).CompareTo(DateTime.Now) < 0)
                {
                    File.Delete(filePath);
                }
            }
        }
    }
View Code

 

4. 在 Global.asax 文件 Application_Start 方法中載入你的 log4net.config 文件，並調用 LogHelper類測試記錄日誌。

log4net.Config.XmlConfigurator.Configure(new FileInfo(Server.MapPath("~/log4net.config")));

            LogHelper.Default.WriteInfo("AppStart");

            LogHelper.Default.WriteWarning("Warning");
            LogHelper.Default.WriteError("Error");
            LogHelper.Default.WriteFatal("Fatal");

            try
            {
                int a = 3 / 4;
                int r = 4 / a;
            }
            catch (Exception ex)
            {
                LogHelper.Default.WriteError(ex.Message, ex);
            }

5. 日誌效果圖

 

可能遇到的問題

由於 log4net 預設是獨占文件的，如果程式部署在FTP空間上又需要下載日誌文件的時候，會發現無法下載（進程被占用），此時需要更改 Appender（輸出源） 的 lockingModel 。

更多LockingModel 信息，請參考 https://logging.apache.org/log4net/release/sdk/html/P_log4net_Appender_FileAppender_LockingModel.htm

<!--不以獨占方式記錄日誌,僅在記錄每個日誌的最短時間內鎖定,因為部署到伺服器上遇到了文件被占用無法下載日誌-->
<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />

示例下載

 

參考

https://logging.apache.org/log4net/release/manual/introduction.html

https://github.com/apache/logging-log4net/

https://stackify.com/log4net-guide-dotnet-logging/?utm_referrer=https://www.google.com/

http://www.cnblogs.com/LiZhiW/p/4317198.html?utm_source=tuicool&utm_medium=referral

http://lovecjh.com/2018/06/08/log4net%E4%BD%BF%E7%94%A8/

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C#線程安全類型
    1、IProducerConsumerCollection (線程安全介面) 此介面的所有實現必須都啟用此介面的所有成員，若要從多個線程同時使用。 using System; using System.Collections; using System.Collections.Concurrent; ...
  • C#面向對象之三大特性： 封裝
    學到封裝就會想到訪問修飾符，說到訪問修飾符，就會想到訪問等級，或者說是訪問能力的大小。當然也少不了預設的訪問類型。 封裝 被定義為"把一個或多個項目封閉在一個物理的或者邏輯的包中"。在面向對象程式設計方法論中，封裝是為了防止對實現細節的訪問。 抽象和封裝是面向對象程式設計的相關特性。抽象允許相關信息 ...
  • C# Task用法
    1、Task的優勢 ThreadPool相比Thread來說具備了很多優勢，但是ThreadPool卻又存在一些使用上的不方便。比如： ◆ ThreadPool不支持線程的取消、完成、失敗通知等交互性操作； ◆ ThreadPool不支持線程執行的先後次序； 以往，如果開發者要實現上述功能，需要完成 ...
  • C# 之 static的用法詳解
    一、靜態類 靜態類與非靜態類的重要區別在於靜態類不能實例化，也就是說，不能使用 new 關鍵字創建靜態類類型的變數。在聲明一個類時使用static關鍵字，具有兩個方面的意義：首先，它防止程式員寫代碼來實例化該靜態類；其次，它防止在類的內部聲明任何實例欄位或方法。 1、靜態類的主要特性： [1] 僅包 ...
  • ASP.NET Core 2.1中基於角色的授權
     ASP.NET Core 2.1中基於角色的授權 授權是來描述用戶能夠做什麼的過程。例如，只允許管理員用戶可以在電腦上進行軟體的安裝以及卸載。而非管理員用戶只能使用軟體而不能進行軟體的安裝以及卸載。它是獨立的而又與驗證配合使用，需要身份驗證機制。對於應用程式來說，首先需要進行身份驗證，然後進行進 ...
  • ASP.NET MVC 項目設置，移除多餘的響應頭，woff,woff2 字體文件請求處理
    移除 X-AspNetMvc-Version 在 Global.asax 的 Application_Start添加代碼 移除 X-AspNet-Version 在 web.config 下的 system.web 節點下設置 enableVersionHeader=false 移除 X-Power ...
  • .NET: 談談C#中的擴展方法
    擴展方法（Extension Methods）是C#3.0時引入的新特性，相信很多人都聽過並且也都用過，最常見的是在LINQ中的使用。 不僅如此，在開發中，我們也可以創建自己擴展方法，使用它來優化類的設計、簡化代碼。本文將簡單地介紹擴展方法的概念、定義、使用場景以及要註意的點。 不僅如此，在開發中， ...
  • C#基本數據類型
    1、值類型和引用類型 值類型 簡單類型：int/double/float/char/bool/ 枚舉：enum 結構：struct 引用類型 類、數組、介面、字元串 區別： 值類型 存儲在記憶體的棧中，從棧中可以快速訪問數據，值類型存儲的是實際數據 將一個值類型變數賦值給另一個值類型變數，屬於值被覆制 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類