首页
/ Serilog 与 ASP.NET Core 集成教程

Serilog 与 ASP.NET Core 集成教程

2024-09-28 19:11:30作者:郜逊炳

1. 目录结构及介绍

Serilog.AspNetCore 是一个用于将 ASP.NET Core 应用的日志集成到 Serilog 的扩展库。下面是这个项目的主要目录结构概览:

  • assets:可能存放一些示例资源或工具。
  • samples/Samples:包含示例应用代码,演示如何在实际项目中使用 Serilog 与 ASP.NET Core 的集成。
  • src/Serilog.AspNetCore:主要的源码目录,包含了所有实现 Serilog 在 ASP.NET Core 中集成的核心类。
  • test/Serilog.AspNetCore.Tests:测试目录,确保库功能正常工作的单元测试。
  • .gitattributes, .gitignore: 版本控制相关的配置文件。
  • appveyor.yml, build.sh, global.json, setup.ps1: 构建脚本和其他CI/CD相关配置。
  • LICENSE, README.md:项目许可协议以及快速入门指南。
  • serilog-aspnetcore.sln, serilog-aspnetcore.sln.DotSettings: 解决方案文件及Visual Studio设置。

2. 项目的启动文件介绍

在 ASP.NET Core 应用中,启动流程通常始于 Program.cs 文件。对于集成 Serilog,你需要在这个文件中先配置 Serilog,然后构建你的应用。一个典型的配置过程如下:

using Serilog;
...
public static void Main(string[] args)
{
    Log.Logger = new LoggerConfiguration()
        .WriteTo.Console() // 输出日志到控制台
        .CreateLogger();

    try
    {
        Log.Information("Starting web application");
        var builder = WebApplicationBuilder.Create(args);
        
        // 添加 Serilog 到服务容器
        builder.Services.AddSerilog();
        
        var app = builder.Build();
        
        // 设置路由等其他配置
        app.MapGet("/", () => "Hello World!");
        app.Run();
    }
    catch (Exception ex)
    {
        Log.Fatal(ex, "Application terminated unexpectedly");
    }
    finally
    {
        Log.CloseAndFlush();
    }
}

这里,通过 Log.Logger 初始化配置了 Serilog,并通过 AddSerilog() 方法将其添加到 DI 容器中,以便全局使用。

3. 项目的配置文件介绍

对于 Serilog 与 ASP.NET Core 的集成,配置可以是代码内的,也可以来自外部配置文件如 appsettings.json。基本配置通常不需要直接修改库本身的配置文件,而是调整你的应用配置来控制日志行为。

appsettings.json 示例片段:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  ...
}

在 Serilog 的上下文中,你可能会在配置之前或之后进行更复杂的Serilog设置,例如:

var loggerConfig = new LoggerConfiguration()
    .ReadFrom.Configuration(builder.Configuration); // 从appsettings读取配置
// 这里还可以添加更多的Serilog特有配置
Log.Logger = loggerConfig.CreateLogger();

记住,为了启用Serilog的智能请求日志记录(如果需要),你还需要在配置完Serilog后,在中间件链中调用 UseSerilogRequestLogging()

以上就是使用 Serilog 于 ASP.NET Core 应用的基本步骤和配置概述。实际使用时,可根据具体需求调整配置细节。

登录后查看全文
热门项目推荐
相关项目推荐