在Asp.Net MVC 中配置 Serilog

 

Serilog 是一種非常簡便記錄log 的處理方式，使用Serilog可以生成本地的text文件， 也可以通過 Seq 來在Web界面中查看具體的log內容。

接下來就簡單的介紹一下在Asp.Net MVC中如何配置是Serilog 生效：

 

1）：下載並且安裝Seq，具體的下載URL 為 【http://getseq.net/Download】，安裝到默認的路徑之后，實際上時候啟動了一個Win Service，並且監聽的端口號默認為 5341.

安裝的最后一步截圖如下：

 

然后我們到Service列表中可以找到對應的Service， 如下圖所示：

 

2）：創建一個Asp.Net MVC 5的一個工程， 然后通過 Nuget 下載並且安裝 對應的 package，如下圖所示

　　

 

3）：在 App_Start 文件夾下創建一個 class 叫做 SerilogConfig.cs ， 代碼如下所示

using Serilog;
using SerilogWeb.Classic.Enrichers;
using System;
using System.Collections.Generic;
using System.Configuration;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Web;
using System.Web.Hosting;

namespace TestSerilog.App_Start
{
    public class SerilogConfig
    {
        public static ILogger CreateLogger()
        {
            var logpath = HostingEnvironment.MapPath("~");
            var config = new LoggerConfiguration()
                .Enrich.WithMachineName()
                .Enrich.WithProperty("ApplicationName", AssemblyTitle)
                .Enrich.With<HttpRequestClientHostIPEnricher>()
                .Enrich.With<HttpRequestRawUrlEnricher>()
                .Enrich.With<HttpRequestIdEnricher>()
                .Enrich.With<UserNameEnricher>()
                //.Enrich.WithProperty("RuntimeVersion", Environment.Version)
                // this ensures that calls to LogContext.PushProperty will cause the logger to be enriched
                .Enrich.FromLogContext()
                .MinimumLevel.Verbose()
                .WriteTo.Seq(ConfigurationManager.AppSettings["SeqServer"], apiKey: ConfigurationManager.AppSettings["SeqApiKey"])
                .WriteTo.RollingFile(Path.Combine(logpath, "Logs\\EricSunTestLog-{Date}.log"), retainedFileCountLimit: null, outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {SourceContext} - ({MachineName}|{HttpRequestId}|{UserName}) {Message}{NewLine}{Exception}");
            return config.CreateLogger();
        }

        public static string AssemblyTitle
        {
            get
            {
                var attributes = typeof(SerilogConfig).Assembly.GetCustomAttributes(typeof(AssemblyTitleAttribute), false);
                if (attributes.Length > 0)
                {
                    var titleAttribute = (AssemblyTitleAttribute)attributes[0];
                    if (titleAttribute.Title.Length > 0)
                        return titleAttribute.Title;
                }
                return Path.GetFileNameWithoutExtension(Assembly.GetEntryAssembly().CodeBase);
            }
        }
    }
}

 

4）：在 Web.config 中添加補全所用到的 appSettings

  <appSettings>
    <add key="SeqServer" value="http://localhost:5341/" />
    <add key="SeqApiKey" value="" />
  </appSettings>

 

5）：在 Startup.cs 中添加如下代碼完成注冊

using Microsoft.Owin;
using Owin;
using Serilog;
using TestSerilog.App_Start;

[assembly: OwinStartupAttribute(typeof(TestSerilog.Startup))]
namespace TestSerilog
{
    public partial class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            ConfigureAuth(app);
            Log.Logger = SerilogConfig.CreateLogger();
        }
    }
}

 

6）： 在 HomeController 中的 Index Action 中添加如下代碼，測試對應的Debug，Information，Warning 和 Error 方法

using Serilog;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;

namespace TestSerilog.Controllers
{
    public class HomeController : Controller
    {
        private ILogger _logger = Log.Logger; 

        public ActionResult Index()
        {
            _logger.Debug("This is index -- debug.");
            _logger.Information("This is index -- information.");
            _logger.Warning("This is index -- warning.");
            _logger.Error("This is index -- error.");
            return View();
        }

        public ActionResult About()
        {
            ViewBag.Message = "Your application description page.";

            return View();
        }

        public ActionResult Contact()
        {
            ViewBag.Message = "Your contact page.";

            return View();
        }
    }
}

 

7）：直接 VS 2015 運行之后， 再去 http://localhost:5341/#/events 中觀察對應的 log 記錄， 如下截圖

 

 

這樣簡單的配置 Serilog 就完成了， 同時我們也可以到 C:\ProgramData\Seq\Logs 目錄中找到 Log 的文本文件。

更多內容請看如下鏈接：

http://serilog.net/

https://github.com/serilog/serilog