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); } } } }
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/