ASP.NET MVC 与NLog的使用

浅浅的花香味﹌ 2022-03-31 03:38 246阅读 0赞

NLog是一个.NET 下一个完善的日志工具，个人已经在项目中使用很久，与ELMAH相比，可能EAMAH更侧重 APS.NET MVC 包括调试路由，性能等方面，而NLog则更简洁。

github: [https://github.com/NLog/NLog][https_github.com_NLog_NLog]  
web: [http://nlog-project.org][http_nlog-project.org]  
logview：[http://www.gibraltarsoftware.com/loupe/extensions/nlog][http_www.gibraltarsoftware.com_loupe_extensions_nlog]  
[http://stackoverflow.com/questions/710863/log4net-vs-nlog][http_stackoverflow.com_questions_710863_log4net-vs-nlog]  
[http://stackoverflow.com/questions/4091606/most-useful-nlog-configurations][http_stackoverflow.com_questions_4091606_most-useful-nlog-configurations]

> Supported targets include:  
> Files - single file or multiple, with automatic file naming and archival  
> Event Log - local or remote  
> Database - store your logs in databases supported by .NET  
> Network - using TCP, UDP, SOAP, MSMQ protocols  
> Command-line console - including color coding of messages  
> E-mail - you can receive emails whenever application errors occur  
> ASP.NET trace  
> ... and many more
> 
> Other key features:  
> very easy to configure, both through configuration file and programmatically  
> easy-to-use logger pattern known from log4xxx  
> advanced routing using buffering, asynchronous logging, load balancing, failover, and more  
> cross-platform support: .NET Framework, .NET Compact Framework and Mono (on Windows and Unix)

# 安装 #

[![image][]][image 1]

# 配置 #

<?xml version="1.0" encoding="utf-8" ?>
    <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
      
    
      
      
      <targets>
        
        
        <target name="console" xsi:type="ColoredConsole" layout="[${date:format=yyyy-MM-dd HH\:mm\:ss}][${level}] ${message} ${exception}"/>
    
        
        <target name="file" xsi:type="AsyncWrapper" queueLimit="5000" overflowAction="Discard">
          <target xsi:type="File" fileName="${basedir}/logs/${shortdate}/${level}.log"  layout="${longdate} ${uppercase:${level}} ${message}"  maxArchiveFiles="100" />
        </target>
        
        
        <target name="database" xsi:type="Database"  useTransactions="true" connectionString="Data Source=xxxxxxxx;Initial Catalog=Log;Persist Security Info=True;User ID=sa;Password=123456"  commandText="insert into NLogException_HomeinnsInterface([CreateOn],[Origin],[LogLevel], [Message], [Exception],[StackTrace]) values (getdate(), @origin, @logLevel, @message,@exception, @stackTrace);">
          
          <parameter name="@origin" layout="${callsite}"/>
          
          <parameter name="@logLevel" layout="${level}"/>
          
          <parameter name="@message" layout="${message}"/>
          
          <parameter name="@exception" layout="${exception}" />
          
          <parameter name="@stackTrace" layout="${stacktrace}"/>
        </target>
    
        
        <target name="email" xsi:type="Mail"
                   header="-----header------"
                   footer="-----footer-----"
                   layout="${longdate} ${level} ${callsite} ${message} ${exception:format=Message, Type, ShortType, ToString, Method, StackTrace}"
                   html="false"
                   encoding="UTF-8"
                   addNewLines="true"
                   subject="${message}"
                   to=""
                   from=""
                   body="${longdate} ${level} ${callsite} ${message} ${exception:format=Message, Type, ShortType, ToString, Method, StackTrace}"
                   smtpUserName=""
                   enableSsl="false"
                   smtpPassword=""
                   smtpAuthentication="Basic"
                   smtpServer="smtp.163.com"
                   smtpPort="25">
        </target>
      </targets>
      <rules>
        
        <logger name="*" minlevel="Trace" writeTo="console" />
        <logger name="*" minlevel="Info" writeTo="file" />
        <logger name="*" minlevel="Error" writeTo="database"/>
        <logger name="*" minlevel="Fatal" writeTo="email" />
      </rules>
    </nlog>

配置什么的也没有什么好说的，跟相对Log4j配置简洁些，支持 控制台，文件（异步），数据库，Email，够用了，其他的方式还没有研究。

# 日志查看 #

这里推荐一款日志查看工具：[Loupe][http_www.gibraltarsoftware.com_loupe_extensions_nlog] ，支持.NET 平台下集成,在Asp.NET MVC 下只需要配置Nuget引用相应的包。

`Install-Package Gibraltar.Agent.Web.Mvc`

`注册拦截器`

using Gibraltar.Agent;
        using Gibraltar.Agent.Web.Mvc.Filters;
    
        public class MvcApplication : System.Web.HttpApplication
        {
            protected void Application_Start()
            {
                // Initialize Gibraltar Loupe
                Log.StartSession();
                GlobalConfiguration.Configuration.Filters.Add(new WebApiRequestMonitorAttribute());
                GlobalFilters.Filters.Add(new MvcRequestMonitorAttribute());
                GlobalFilters.Filters.Add(new UnhandledExceptionAttribute());
             }
          }

[![image][image 2]][image_image 2]

# 结合SignalR #

今天看到一篇与signalr结合的文章，可以把记录的日志主动推送到浏览器 ： [http://www.codeproject.com/Articles/758633/Streaming-logs-with-SignalR][http_www.codeproject.com_Articles_758633_Streaming-logs-with-SignalR] ，原理NLog支持[MethodCallTarget][]特性，发生异常时，可以触发Signalr的相关方法，从而推送错误消息到浏览器。

使用OWIN宿主，[Open Web Interface for .NET][] (OWIN)在Web服务器和Web应用程序之间建立一个抽象层。OWIN将网页应用程序从网页服务器分离出来，然后将应用程序托管于OWIN的程序而离开IIS之外。

public class SignalRTargetHub : Hub
    {
        public void Hello()
        {
            this.Clients.Caller.logEvent(
                DateTime.UtcNow.ToLongTimeString(),
                "info",
                "SignalR connected");
        }
    
        static IHubContext signalRHub;
        public static void Send(string longdate, string logLevel, String message)
        {
            if (signalRHub == null)
            {
                signalRHub = GlobalHost.ConnectionManager.GetHubContext<SignalRTargetHub>();
            }
    
            if (signalRHub != null)
            {
                signalRHub.Clients.All.logEvent(longdate, logLevel, message);
            }
        }
    }
    
    [assembly: OwinStartup(typeof(SignalRStartup))]
    public class SignalRStartup
    {
        public void Configuration(IAppBuilder app)
        {
            app.MapSignalR();
        }
    }

注册Global事件

Logger logger = NLog.LogManager.GetCurrentClassLogger();
      void Application_Error(object sender, EventArgs e)
        {
            Exception lastException = Server.GetLastError();
            logger.Fatal("Request: '{0}'\n Exception:{1}", HttpContext.Current.Request.Url, lastException);
        }

> Refer:  
> How to NLog (2.1) with VisualStudio 2013  
> [http://www.codeproject.com/Tips/749612/How-to-NLog-with-VisualStudio][http_www.codeproject.com_Tips_749612_How-to-NLog-with-VisualStudio]  
> Logging: How to Growl with NLog 3  
> [http://www.codeproject.com/Articles/786304/Logging-How-to-Growl-with-NLog-or][http_www.codeproject.com_Articles_786304_Logging-How-to-Growl-with-NLog-or]  
> Five methods to Logging in MVC 3.0(介绍较详细，需FQ)  
> [http://www.codeproject.com/Tips/237171/Five-methods-to-Logging-in-MVC][http_www.codeproject.com_Tips_237171_Five-methods-to-Logging-in-MVC]  
> 微软最新的Web服务器Katana发布了版本3（OWIN）  
> [http://www.infoq.com/cn/news/2014/08/Katana-3][http_www.infoq.com_cn_news_2014_08_Katana-3]

[https_github.com_NLog_NLog]: https://github.com/NLog/NLog
[http_nlog-project.org]: http://nlog-project.org
[http_www.gibraltarsoftware.com_loupe_extensions_nlog]: http://www.gibraltarsoftware.com/loupe/extensions/nlog
[http_stackoverflow.com_questions_710863_log4net-vs-nlog]: http://stackoverflow.com/questions/710863/log4net-vs-nlog
[http_stackoverflow.com_questions_4091606_most-useful-nlog-configurations]: http://stackoverflow.com/questions/4091606/most-useful-nlog-configurations
[image]: /images/20220331/694a136df4c24d21aadca2733798224d.png
[image 1]: https://images0.cnblogs.com/blog/365537/201311/29101803-f1fb12824a084e3aabcbd73c1b6695a5.png
[image 2]: https://images0.cnblogs.com/blog/365537/201408/311112144855699.png
[image_image 2]: /images/20220331/72b7905857b54aa193ddfc0a8a2ff443.png
[http_www.codeproject.com_Articles_758633_Streaming-logs-with-SignalR]: http://www.codeproject.com/Articles/758633/Streaming-logs-with-SignalR
[MethodCallTarget]: http://nlog-project.org/documentation/v2.0.1/html/T_NLog_Targets_MethodCallTarget.htm
[Open Web Interface for .NET]: http://owin.org/
[http_www.codeproject.com_Tips_749612_How-to-NLog-with-VisualStudio]: http://www.codeproject.com/Tips/749612/How-to-NLog-with-VisualStudio
[http_www.codeproject.com_Articles_786304_Logging-How-to-Growl-with-NLog-or]: http://www.codeproject.com/Articles/786304/Logging-How-to-Growl-with-NLog-or
[http_www.codeproject.com_Tips_237171_Five-methods-to-Logging-in-MVC]: http://www.codeproject.com/Tips/237171/Five-methods-to-Logging-in-MVC
[http_www.infoq.com_cn_news_2014_08_Katana-3]: http://www.infoq.com/cn/news/2014/08/Katana-3