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 约定的字符串转换解释
    1. %m、%message 输出的日志消息
    2. %d、%datetime 输出当前语句运行的时刻,格式%date{yyyy-MM-dd HH:mm:ss,fff}
    3. %r、%timestamp 输出程序从运行到执行到当前语句时消耗的毫秒数
    4. %p、%level 日志的当前优先级别
    5. %c、%logger 当前日志对象的名称
    6. %L、%line 输出语句所在的行号
    7. %F、%file 输出语句所在的文件名,警告:只在调试的时候有效,调用本地信息会影响性能
    8. %a、%appdomain 引发日志事件的应用程序域的名称。
    9. %C、%class、%type 引发日志请求的类的全名,警告:会影响性能
    10. %exception 异常信息
    11. %u、%identity 当前活动用户的名字,我测试的时候%identity返回都是空的。警告:会影响性能
    12. %l、%location 引发日志事件的名空间、类名、方法、行号。警告:会影响性能,依赖pdb文件
    13. %M、%method 发生日志请求的方法名,警告:会影响性能
    14. %n、%newline 换行符
    15. %x、%ndc NDC(nested diagnostic context)
    16. %X、%mdc、%P、%properties 等介于 %property
    17. %property 输出{log4net:Identity=, log4net:UserName=, log4net:HostName=}
    18. %t、%thread 引发日志事件的线程,如果没有线程名就使用线程号。
    19. %w、%username 当前用户的WindowsIdentity,类似:HostName/Username。警告:会影响性能
    20. %utcdate 发生日志事件的UTC时间。例如:%utcdate{HH:mm:ss,fff}
    21. %% 输出一个百分号

    更多内容请参考:http://logging.apache.org/log4net/release/sdk/html/T_log4net_Layout_PatternLayout.htm

如何使用

以 ASP.NET MVC 项目为例

1.使用 Nuget 安装 log4net ,

  1. PM> Install-Package log4net

2.创建 log4net.config 配置文件 ,并且将该文件的属性“复制到输出目录”修改为 “始终复制”

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <configuration>
  3. <configSections>
  4. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net-net-2.0"/>
  5. </configSections>
  6. <log4net>
  7. <root>
  8. <level value="ALL" />
  9. <appender-ref ref="LogFileAppender" />
  10. <!--<appender-ref ref="EventLogAppender" />-->
  11. </root>
  12. <!--定义输出到文件-->
  13. <appender name ="LogFileAppender" type="log4net.Appender.RollingFileAppender">
  14. <!--定义文件存放位置-->
  15. <param name="File" value ="App_Data\"/>
  16. <param name="AppendToFile" value="true" />
  17. <param name="MaxSizeRollBackups" value="" />
  18. <param name="MaxFileSize" value="" />
  19. <param name="StaticLogFileName" value="false" />
  20. <!--文件名格式-->
  21. <param name="DatePattern" value="yyyy.MM.dd'.txt'" />
  22. <param name="RollingStyle" value ="Date" />
  23. <!--不以独占方式记录日志,仅在记录每个日志的最短时间内锁定,因为部署到服务器上遇到了文件被占用无法下载日志-->
  24. <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
  25. <layout type="log4net.Layout.PatternLayout">
  26. <!--定义输出格式-->
  27. <!--示例 -- ::, -线程ID:[] 日志级别:[INFO ] : [日志信息]-->
  28. <param name="ConversionPattern" value="%date 线程ID:[%thread] 日志级别:[%-5level] : [%message]%newline"/>
  29. </layout>
  30. <!--过滤级别 FATAL > ERROR > WARN > INFO > DEBUG-->
  31. <filter type="log4net.Filter.LevelRangeFilter">
  32. <param name="LevelMin" value="DEBUG" />
  33. <param name="LevelMax" value="FATAL" />
  34. </filter>
  35. </appender>
  36. <!--定义输出到 windows 事件中-->
  37. <appender name="EventLogAppender" type="log4net.Appender.EventLogAppender">
  38. <layout type="log4net.Layout.PatternLayout">
  39. <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline"></conversionPattern>
  40. </layout>
  41. </appender>
  42. </log4net>
  43. </configuration>

3.创建 LogHelper 类,提供日志记录的方法

  1. public class LogHelper
  2. {
  3. private ILog _log4Net = null;
  4. private const string DEFAULT_LOGGER_NAME = "Logger";
  5. /// <summary>
  6. /// Prevents a default instance of the <see cref="LogWriter"/> class from being created.
  7. /// </summary>
  8. /// <param name="log4NetInstance">The log4net instance to be used.</param>
  9. private LogHelper(ILog log4NetInstance)
  10. {
  11. _log4Net = log4NetInstance;
  12. }
  13.  
  14. /// <summary>
  15. /// Gets a logger with the specified configuration name.
  16. /// </summary>
  17. /// <param name="configName">Name of the logger in the configuration.</param>
  18. /// <returns>The logger obtained.</returns>
  19. /// <exception cref="System.Configuration.ConfigurationException">Thrown when no logger with the specified configuration name was found.</exception>
  20. public static LogHelper GetLogger(string configName)
  21. {
  22. var logger = LogManager.GetLogger(configName);
  23. if (logger == null)
  24. {
  25. throw new ArgumentException(string.Format("No logger configuration named '{0}' was found in the configuration.", configName), "configName");
  26. }
  27. return new LogHelper(logger);
  28. }
  29.  
  30. /// <summary>
  31. /// Gets the default.
  32. /// </summary>
  33. public static LogHelper Default
  34. {
  35. get
  36. {
  37. return GetLogger(DEFAULT_LOGGER_NAME);
  38. }
  39. }
  40.  
  41. /// <summary>
  42. /// Writes an information level logging message.
  43. /// </summary>
  44. /// <param name="message">The message to be written.</param>
  45. public void WriteInfo(object message)
  46. {
  47. _log4Net.Info(message);
  48. }
  49.  
  50. /// <summary>
  51. /// Writes a warning level logging message.
  52. /// </summary>
  53. /// <param name="message">The message to be written.</param>
  54. public void WriteWarning(object message)
  55. {
  56. _log4Net.Warn(message);
  57. }
  58.  
  59. /// <summary>
  60. /// Writes a warning level logging message.
  61. /// </summary>
  62. /// <param name="message">The message to be written.</param>
  63. /// <param name="exception">The exception.</param>
  64. public void WriteWarning(object message, System.Exception exception)
  65. {
  66. _log4Net.Warn(message, exception);
  67. }
  68.  
  69. /// <summary>
  70. /// Writes the error.
  71. /// </summary>
  72. /// <param name="message">The message to be written.</param>
  73. public void WriteError(object message)
  74. {
  75. _log4Net.Error(message);
  76. }
  77.  
  78. /// <summary>
  79. /// Writes the error level logging message..
  80. /// </summary>
  81. /// <param name="message">The message to be written.</param>
  82. /// <param name="exception">The exception.</param>
  83. public void WriteError(object message, System.Exception exception)
  84. {
  85. _log4Net.Error(message, exception);
  86. }
  87.  
  88. /// <summary>
  89. /// Writes the fatal error level logging message..
  90. /// </summary>
  91. /// <param name="message">The message to be written.</param>
  92. public void WriteFatal(object message)
  93. {
  94. _log4Net.Fatal(message);
  95. }
  96.  
  97. /// <summary>
  98. /// Writes the fatal error level logging message..
  99. /// </summary>
  100. /// <param name="message">The message to be written.</param>
  101. /// <param name="exception">The exception.</param>
  102. public void WriteFatal(object message, System.Exception exception)
  103. {
  104. _log4Net.Fatal(message, exception);
  105. }
  106.  
  107. public void DeleteLog()
  108. {
  109. string logDirPath = Path.Combine(Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location), "Log");
  110. if (!Directory.Exists(logDirPath)) return;
  111. int days = ;
  112. foreach (string filePath in Directory.GetFiles(logDirPath))
  113. {
  114. DateTime dt;
  115. DateTime.TryParse(Path.GetFileNameWithoutExtension(filePath).Replace(@"Log\", "").Replace(".", "-"), out dt);
  116. if (dt.AddDays(days).CompareTo(DateTime.Now) < )
  117. {
  118. File.Delete(filePath);
  119. }
  120. }
  121. }
  122. }

4. 在 Global.asax 文件 Application_Start 方法中加载你的 log4net.config 文件,并调用 LogHelper类测试记录日志。

  1. log4net.Config.XmlConfigurator.Configure(new FileInfo(Server.MapPath("~/log4net.config")));
  2. LogHelper.Default.WriteInfo("AppStart");
  3.  
  4. LogHelper.Default.WriteWarning("Warning");
  5. LogHelper.Default.WriteError("Error");
  6. LogHelper.Default.WriteFatal("Fatal");
  7.  
  8. try
  9. {
  10. int a = / ;
  11. int r = / a;
  12. }
  13. catch (Exception ex)
  14. {
  15. LogHelper.Default.WriteError(ex.Message, ex);
  16. }

5. 日志效果图

可能遇到的问题

由于 log4net 默认是独占文件的,如果程序部署在FTP空间上又需要下载日志文件的时候,会发现无法下载(进程被占用),此时需要更改 Appender(输出源) 的 lockingModel 。

更多LockingModel 信息,请参考 https://logging.apache.org/log4net/release/sdk/html/P_log4net_Appender_FileAppender_LockingModel.htm

  1. <!--不以独占方式记录日志,仅在记录每个日志的最短时间内锁定,因为部署到服务器上遇到了文件被占用无法下载日志-->
  2. <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/

ASP.NET MVC 使用 Log4net 记录日志的更多相关文章

  1. asp.net mvc中用 log4net记录日志到数据库中

    1.log4net官网配置相关,创建数据库 http://logging.apache.org/log4net/release/config-examples.html CREATE TABLE [d ...

  2. 使用ASP.NET MVC操作过滤器记录日志(转)

    使用ASP.NET MVC操作过滤器记录日志 原文地址:http://www.singingeels.com/Articles/Logging_with_ASPNET_MVC_Action_Filte ...

  3. [翻译] 使用ASP.NET MVC操作过滤器记录日志

    [翻译] 使用ASP.NET MVC操作过滤器记录日志 原文地址:http://www.singingeels.com/Articles/Logging_with_ASPNET_MVC_Action_ ...

  4. ASP.NET MVC中Log4Net记录错误日志的使用

    第一.在管理NuGet程序包 =>下载 Log4Net 第二.在web.config配置Log4Net 1:在<configuration>节点下 <configSection ...

  5. ASP.NET MVC使用log4net

    本文介绍如何在ASP.NET MVC中使用log4net来记录日志文件. 参考链接:https://www.codeproject.com/Articles/823247/How-to-use-Apa ...

  6. ASP.NET Core使用log4net记录日志

    .NET常用的日志组件有NLog.Log4net等,.NET CORE下微软也自带了日志组件,到目前为止还没用过,而我本人常用的是log4net,下面简单讲讲.NET CORE下怎么使用log4net ...

  7. ASP.NET/MVC 配置log4net启用写错误日志功能

    <?xml version="1.0" encoding="utf-8"?> <!-- 有关如何配置 ASP.NET 应用程序的详细信息,请访 ...

  8. asp.net mvc集成log4net

    第一步:在web项目的引用中添加log4net.dll,可以通过Nuget直接下载并安装: 第二步:在web项目的web.config配置文件的configuration节点内添加log4net节点, ...

  9. 在ASP.NET MVC中使用Log4Net记录异常日志,出错时导向到静态页

    本篇体验在ASP.NET MVC 4中使用Log4Net记录日志. 通过NuGet安装Log4Net. 需求是:当出错时导向到Error.html静态页面,Log4Net记录错误信息. 大致的思路是: ...

随机推荐

  1. base64编码是什么1

    首先明确一点base64 是一种编码格式.就想UNICODE一样,能在电脑上表示所有字符,或者换句话说通过编码能让电脑理解你想要表示的字符(因为电脑只知道0和1 ) 就像ascII 中 0100 00 ...

  2. mac install brew

    $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" ...

  3. 【Java】使用IDE开发工具远程调试Java代码

    概述 服务端程序运行在一台远程服务器上,我们可以在本地服务端的代码(前提是本地的代码必须和远程服务器运行的代码一致)中设置断点,每当有请求到远程服务器时时能够在本地知道远程服务端的此时的内部状态 测试 ...

  4. [VBS]检测计算机各硬件信息

    1)批处理脚本:Rhea_HardwareInfoCollector.bat 调用VBScript脚本Rhea_HardwareInfoCollector.vbs,并将结果打印到文件Rhea_Resu ...

  5. setInterval与setTimeout 的区别

    setInterval在执行完一次代码之后,经过了那个固定的时间间隔,它还会自动重复执行代码,而setTimeout只执行一次那段代码     用法: setInterval("alert( ...

  6. Servlet------EL表达式

    EL表达式是: Expression Language.一种写法非常简介的表达式.语法简单易懂,便于使用..获取作用域的数据.... 对比: 传统方式获取作用域数据:                缺 ...

  7. jsp里面不能使用${pageContext.request.contextPath}解决方案

    1.在jsp中使用${pageContext.request.contextPath}获取相对路径,可是最后路径变为:http://localhost:8080/oneself/$%7BpageCon ...

  8. 2019.01.22 hdu5195 DZY Loves Topological Sorting(贪心+线段树)

    传送门 题意简述:给出一张DAGDAGDAG,要求删去不超过kkk条边问最后拓扑序的最大字典序是多少. 思路:贪心帮当前不超过删边上限且权值最大的点删边,用线段树维护一下每个点的入度来支持查询即可. ...

  9. String拼接

    1. String[] members=ArrayDATA_IDS; String usernames = ""; for(String id :members) { userna ...

  10. 计算给定多项式在给定点X处的值

    //计算多项式求值 //计算多项式求值#include<iostream>#include<ctime>#include<cmath>using namespace ...