.NET Core日志记录之第三方框架Serilog

在本攻略中，我们将深入讲解如何使用第三方框架Serilog进行.NET Core日志记录，并提供两个示例说明。

什么是Serilog？

Serilog是一个.NET Core日志记录框架，它提供了一种简单、灵活、可扩展的方式来记录应用程序的日志。Serilog支持多种输出格式和目标，包括控制台、文件、数据库、Elasticsearch等。

如何使用Serilog？

以下是使用Serilog进行.NET Core日志记录的步骤：

1. 安装Serilog和Serilog.Sinks.Console NuGet包。

dotnet add package Serilog
dotnet add package Serilog.Sinks.Console

1. 在Program.cs文件中配置Serilog。

using Serilog;

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

        CreateHostBuilder(args).Build().Run();
    }

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

在上面的代码中，我们在Main方法中配置Serilog，并在CreateHostBuilder方法中使用UseSerilog方法将Serilog添加到主机生成器中。

1. 在需要记录日志的地方使用Serilog。

using Serilog;

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogInformation("Index page visited.");
        return View();
    }
}

在上面的代码中，我们在HomeController中注入ILogger，并在Index方法中使用ILogger.LogInformation方法记录日志。

示例一：将日志记录到文件

以下是将日志记录到文件的示例代码：

1. 安装Serilog.Sinks.File NuGet包。

dotnet add package Serilog.Sinks.File

1. 在Program.cs文件中配置Serilog。

using Serilog;
using Serilog.Events;
using Serilog.Formatting.Compact;

public class Program
{
    public static void Main(string[] args)
    {
        Log.Logger = new LoggerConfiguration()
            .MinimumLevel.Debug()
            .MinimumLevel.Override("Microsoft", LogEventLevel.Warning)
            .Enrich.FromLogContext()
            .WriteTo.Console(new CompactJsonFormatter())
            .WriteTo.File("logs/log.txt", rollingInterval: RollingInterval.Day)
            .CreateLogger();

        CreateHostBuilder(args).Build().Run();
    }

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

在上面的代码中，我们在LoggerConfiguration中添加了WriteTo.File方法，将日志记录到logs/log.txt文件中，并使用RollingInterval.Day参数指定日志文件按天滚动。

示例二：将日志记录到Elasticsearch

以下是将日志记录到Elasticsearch的示例代码：

1. 安装Serilog.Sinks.Elasticsearch NuGet包。

dotnet add package Serilog.Sinks.Elasticsearch

1. 在Program.cs文件中配置Serilog。

using Serilog;
using Serilog.Events;
using Serilog.Formatting.Compact;
using Serilog.Sinks.Elasticsearch;

public class Program
{
    public static void Main(string[] args)
    {
        Log.Logger = new LoggerConfiguration()
            .MinimumLevel.Debug()
            .MinimumLevel.Override("Microsoft", LogEventLevel.Warning)
            .Enrich.FromLogContext()
            .WriteTo.Console(new CompactJsonFormatter())
            .WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri("http://localhost:9200"))
            {
                AutoRegisterTemplate = true,
                IndexFormat = "myapp-{0:yyyy.MM.dd}"
            })
            .CreateLogger();

        CreateHostBuilder(args).Build().Run();
    }

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

在上面的代码中，我们在LoggerConfiguration中添加了WriteTo.Elasticsearch方法，将日志记录到Elasticsearch中，并使用ElasticsearchSinkOptions指定Elasticsearch的URI、自动注册模板和索引格式。

结

在本攻略中，我们深入讲解了如何使用第三方框架Serilog进行.NET Core日志记录，并提供了两个示例说明。通过遵循这些步骤，您应该能够成功使用Serilog记录.NET Core应用程序的日志，并将日志记录到不同的输出格式和目标中。