ASP.NET MVC 使用 Log4net 记录日志

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 ,


1

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 类,提供日志记录的方法

 

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://www.cnblogs.com/sjqq/p/9507845.html

时间: 2024-08-28 14:21:08

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

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

1.log4net官网配置相关,创建数据库 http://logging.apache.org/log4net/release/config-examples.html CREATE TABLE [dbo].[tbl_LogInfo]( [ID] [int] IDENTITY(1,1) NOT NULL, [LogTime] [datetime] NOT NULL, [Thread] [nvarchar](max) NOT NULL, [LogLevel] [nvarchar](max) NUL

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

[翻译] 使用ASP.NET MVC操作过滤器记录日志 原文地址:http://www.singingeels.com/Articles/Logging_with_ASPNET_MVC_Action_Filters.aspx 翻译:Anders Liu 摘要:日志记录是一种常见的交错关注点(Cross-Cutting Concern),很多ASP.NET开发者会在Global.asax文件中处理它.由于MVC是构建在ASP.NET之上的,所以你可以使用同样的解 决方式,但还有更好的方法.这篇文章

ASP.NET MVC使用log4net

本文介绍如何在ASP.NET MVC中使用log4net来记录日志文件. 参考链接:https://www.codeproject.com/Articles/823247/How-to-use-Apache-log-net-library-with-ASP-NET-MVChttp://www.cnblogs.com/suntanyong88/p/4571005.html 第一步: 创建项目ASP.NET Web Application MVC 第二步: Nuget安装log4Net 第三步: 配

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

第一.在管理NuGet程序包 =>下载 Log4Net 第二.在web.config配置Log4Net 1:在<configuration>节点下 <configSections>节点中 配置log4Net节点引用. <!--log4net日志记录--> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net

Asp.Net Core使用Log4net记录日志

log4net的使用方法有很多,这只是我日常使用的一种. 一.往项目中添加Nuget包 log4net和Microsoft.Extensions.Logging.Log4Net.AspNetCore 二.编写配置文件 在web项目下新建文件log4net.config内容如下 <?xml version="1.0" encoding="utf-8" ?> <log4net> <appender name="RollingLog

log4net 使用总结- (2)在ASP.NET MVC 中使用

log4net在ASP.NET MVC中的配置,还有一种配置方式,即不在web.config中,而是单独新建一个log4net.config 在根目录下 第一.引用log4net.dll 第二.在站点根目录下增加log4net.config <?xml version="1.0" encoding="utf-8" ?> <configuration> <configSections> <section name="

log4net 使用总结- (1)在ASP.NET MVC 中使用

1. 去官网下载log4net.dll,增加引用到站点下(你也可以通过nuget 安装) http://logging.apache.org/log4net/download_log4net.cgi 2. 在Web.config中增加配置(这里按日志文件输出) <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, lo

Asp.net core 使用log4net作为日志组件,记录日志到本地。

原文:Asp.net core 使用log4net作为日志组件,记录日志到本地. GitHub demo :https://github.com/zhanglilong23/Asp.NetCore.Demo 1:引入包?首先使用Nuget引入log4net包,版本应>= 2.0.7 2:实现 ILogger 接口 public class Log4NetLogger : ILogger { private readonly ILog _log; private ILoggerRepository

ABP示例程序-使用AngularJs,ASP.NET MVC,Web API和EntityFramework创建N层的单页面Web应用

本片文章翻译自ABP在CodeProject上的一个简单示例程序,网站上的程序是用ABP之前的版本创建的,模板创建界面及工程文档有所改变,本文基于最新的模板创建.通过这个简单的示例可以对ABP有个更深入的了解,每个工程里应该写什么样的代码,代码如何组织以及ABP是如何在工程中发挥作用的. 源文档地址:https://www.codeproject.com/Articles/791740/Using-AngularJs-ASP-NET-MVC-Web-API-and-EntityFram 源码可以