如何在 ASP.Net Core 中使用 Serilog

碼農讀書發表於2021-03-10
ASP.NET

記錄日誌的一個作用就是方便對應用程式進行跟蹤和排錯調查，在實際應用上都是引入 日誌框架，但如果你的 日誌檔案 包含非結構化的資料，那麼查詢起來將是一個噩夢，所以需要在記錄日誌的時候採用結構化方式。

將日誌結構化可以更容易的查詢和分析，做法就是在寫入的時候定義好資料的格式，這種格式包括：xml，json，或者你希望轉成的任何結構。

Serilog 是一個第三方，開源的結構化日誌框架，它的高層封裝可以讓開發者更容易的將日誌記錄到 console，file 和你能想到的各種 儲存系統，這篇文章我們將會討論如何在 ASP.Net Core 中使用 Serilog。

安裝 Serilog

使用 Visual Studio 新建 ASP.Net Core 專案，接下來從 NuGet 上拉幾個包，具體如下：

  • Serilog

這個包提供了對基本的結構化日誌的功能支援。

  • Serilog.AspNetCore

這個包提供了 Serilog 對 AspNetCore 的支援。

  • Serilog.Settings.Configuration

這個包打通了 Serilog 和 Configuration ，這樣你就可以直接從 appsettings.json 中讀取配置。

  • Serilog.Sinks.Console

Console接收器顧名思義就是將 Serilog 的日誌輸出到 Console。

  • Serilog.Sinks.RollingFile

實現了對 滾動檔案 的支援。

使用 Serilog Sink

Serilog 利用 sink 特性將日誌送到不同的地方，比如：text檔案，資料庫，甚至是 ElasticSearch 中，換句話說，sink 特性可以把日誌送到它該去的地方，當所有的 nuget 包都安裝好了之後，下面的程式碼片段展示瞭如何將日誌送到 console 中。


        public HomeController(ILogger<HomeController> logger)
        {
            using (var logConfig = new LoggerConfiguration().WriteTo.Console().CreateLogger())
            {
                logConfig.Information("This is a test data.");
            };

            _logger = logger;
        }

值得注意的是，Serilog 支援多個日誌級別，如：verbose, debug, information, warning, error 和 fatal。

有時候為了除錯目的，將日誌送到 Console 是一個好辦法，但將程式部署到生產之後，更通用的做法就是將日誌記錄到檔案中，這樣方便在生產上實時檢視並做一定程度的日誌分析，剛好這裡的 Serilog.Sink.RollingFile 支援對滾動檔案的支援，下面的程式碼片段展示瞭如何通過程式設計的方式將日誌送到檔案中。


        public HomeController()
        {
            var logger = new LoggerConfiguration().MinimumLevel.Debug().WriteTo
                                                  .RollingFile(@"e:\log.txt", retainedFileCountLimit: 7)
                                                  .CreateLogger();

            for (int i = 0; i < byte.MaxValue; i++)
            {
                logger.Information($"log {i}");
            }
        }

使用 Serilog 替換原生的 Logger

在 ASP.NET Core 中內建了 Logger 元件，這一節中我們一起看看如何使用 Serilog 將其進行替換，在 Program.Main 方法中使用如下程式碼：


    public class Program
    {
        public static void Main(string[] args)
        {
            Log.Logger = new LoggerConfiguration()
             .MinimumLevel.Debug()
             .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
             .Enrich.FromLogContext()
             .WriteTo.Console()
             .CreateLogger();

            try
            {
                Log.Information("Starting web host");
                CreateHostBuilder(args).Build().Run();
            }
            catch (Exception ex)
            {
                Log.Fatal(ex, "Host terminated unexpectedly");
            }
            finally
            {
                Log.CloseAndFlush();
            }
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
              .UseSerilog()
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }

從上面的程式碼中可以看到，我在 CreateHostBuilder 中使用了 UseSerilog() 擴充套件方法來啟動 Serilog，這樣就做好了 Serilog 的替換工作，接下來可以在 Controller 中通過依賴注入的方式獲取 logger 例項，如下程式碼所示：


        public IActionResult Index()
        {
            logger.LogInformation("hello world");

            return View();
        }

日誌是一個應用程式不可或缺的一部分，所以選擇一款 靈活 + 簡單 的日誌框架就顯得特別重要了，Serilog 提供了低配置和易使用的特性讓我們方便的將日誌送到各個地方。

更多精彩，歡迎訂閱 ???

譯文連結：https://www.infoworld.com/article/3314985/how-to-use-serilog-in-aspnet-core.html

相關文章