.net core下優秀的日誌框架使用解析,附原始碼

寒冰2023發表於2023-11-26

在 .NET Core 中,日誌是一個非常重要的元件,它可以幫助我們記錄應用程式的執行情況,以便在出現問題時進行排查。在本文中,我們將介紹五個優秀的 .NET Core 日誌框架,它們分別是 Serilog、NLog、Log4Net、
Microsoft.Extensions.Logging 和 Loupe。我們將為每個框架提供使用方法及步驟,並提供原始碼示例。

1. Serilog

Serilog 是一個高度可擴充套件的 .NET Core 日誌框架,它支援多種輸出格式,包括控制檯、檔案、Elasticsearch 等。Serilog 的特點是可配置性強,支援鏈式呼叫,可以自定義日誌格式和輸出方式。

使用方法

  1. 安裝 Serilog NuGet 包:
Install-Package Serilog
Install-Package Serilog.Sinks.Console
  1. 在程式入口處配置 Serilog:
using Serilog;

public static void Main(string[] args)
{
    Log.Logger = new LoggerConfiguration()
        .MinimumLevel.Debug()
        .WriteTo.Console()
        .CreateLogger();

    // ...
}
  1. 記錄日誌:
Log.Information("This is an information message.");
Log.Warning("This is a warning message.");
Log.Error("This is an error message.");

示例程式碼

using Serilog;

public class Program
{
    public static void Main(string[] args)
    {
        Log.Logger = new LoggerConfiguration()
            .MinimumLevel.Debug()
            .WriteTo.Console()
            .CreateLogger();

        Log.Information("Hello, Serilog!");

        Log.CloseAndFlush();
    }
}

2. NLog

NLog 是一個流行的 .NET Core 日誌框架,它支援多種輸出方式,包括控制檯、檔案、資料庫等。NLog 的特點是配置簡單,易於使用,可以自定義日誌格式和輸出方式。

使用方法

  1. 安裝 NLog NuGet 包:
Install-Package NLog
  1. 在程式入口處配置 NLog:
using NLog.Web;

public static void Main(string[] args)
{
    var logger = NLogBuilder.ConfigureNLog("nlog.config").GetCurrentClassLogger();

    // ...
}
  1. 記錄日誌:
logger.Info("This is an information message.");
logger.Warn("This is a warning message.");
logger.Error("This is an error message.");

示例程式碼

using NLog.Web;

public class Program
{
    public static void Main(string[] args)
    {
        var logger = NLogBuilder.ConfigureNLog("nlog.config").GetCurrentClassLogger();

        logger.Info("Hello, NLog!");

        LogManager.Shutdown();
    }
}

3. Log4Net

Log4Net 是一個成熟的 .NET Core 日誌框架,它支援多種輸出方式,包括控制檯、檔案、資料庫等。Log4Net 的特點是穩定性高,配置靈活,可以自定義日誌格式和輸出方式。

使用方法

  1. 安裝 Log4Net NuGet 包:
Install-Package log4net
  1. 在程式入口處配置 Log4Net:
using log4net;
using log4net.Config;

public static void Main(string[] args)
{
    XmlConfigurator.Configure(new FileInfo("log4net.config"));

    var logger = LogManager.GetLogger(typeof(Program));

    // ...
}
  1. 記錄日誌:
logger.Info("This is an information message.");
logger.Warn("This is a warning message.");
logger.Error("This is an error message.");

示例程式碼

using log4net;
using log4net.Config;

public class Program
{
    private static readonly ILog logger = LogManager.GetLogger(typeof(Program));

    public static void Main(string[] args)
    {
        XmlConfigurator.Configure(new FileInfo("log4net.config"));

        logger.Info("Hello, Log4Net!");
    }
}

4. Microsoft.Extensions.Logging


Microsoft.Extensions.Logging 是 .NET Core 自帶的日誌框架,它支援多種輸出方式,包括控制檯、檔案、EventSource 等。Microsoft.Extensions.Logging 的特點是易於整合,可以與 .NET Core 的依賴注入框架一起使用。

使用方法

  1. 安裝 Microsoft.Extensions.Logging NuGet 包:
Install-Package Microsoft.Extensions.Logging
  1. 在程式入口處配置 Microsoft.Extensions.Logging:
using Microsoft.Extensions.Logging;

public static void Main(string[] args)
{
    var loggerFactory = LoggerFactory.Create(builder =>
    {
        builder.AddConsole();
    });

    var logger = loggerFactory.CreateLogger<Program>();

    // ...
}
  1. 記錄日誌:
logger.LogInformation("This is an information message.");
logger.LogWarning("This is a warning message.");
logger.LogError("This is an error message.");

示例程式碼

using Microsoft.Extensions.Logging;

public class Program
{
    private static readonly ILogger logger;

    static Program()
    {
        var loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole();
        });

        logger = loggerFactory.CreateLogger<Program>();
    }

    public static void Main(string[] args)
    {
        logger.LogInformation("Hello, Microsoft.Extensions.Logging!");
    }
}

5. Loupe

Loupe 是一個全功能的 .NET Core 日誌框架,它支援多種輸出方式,包括控制檯、檔案、資料庫、Web 介面等。Loupe 的特點是功能強大,支援分析、監控、報警等多種高階功能。

使用方法

  1. 安裝 Loupe NuGet 包:
Install-Package Gibraltar.Agent
  1. 在程式入口處配置 Loupe:
using Gibraltar.Agent;

public static void Main(string[] args)
{
    Log.StartSession();

    // ...
}
  1. 記錄日誌:
Log.Information("This is an information message.");
Log.Warning("This is a warning message.");
Log.Error("This is an error message.");

示例程式碼

using Gibraltar.Agent;

public class Program
{
    public static void Main(string[] args)
    {
        Log.StartSession();

        Log.Information("Hello, Loupe!");

        Log.EndSession();
    }
}

以上是五個優秀的 .NET Core 日誌框架的介紹和使用方法。這些框架各有特點,可以根據實際需求選擇合適的框架。無論選擇哪個框架,記得在程式入口處配置日誌,並在適當的地方記錄日誌,以便在出現問題時進行排查。