Serilog 开源项目使用教程

Serilog 开源项目使用教程

serilogSimple .NET logging with fully-structured events项目地址:https://gitcode.com/gh_mirrors/se/serilog

1. 项目的目录结构及介绍

Serilog 是一个用于.NET 平台的日志库，其目录结构清晰，便于理解和使用。以下是 Serilog 项目的主要目录结构及其介绍：

serilog/
├── src/
│   ├── Serilog/
│   ├── Serilog.AspNetCore/
│   ├── Serilog.Sinks.Console/
│   └── ...
├── test/
│   ├── Serilog.Tests/
│   ├── Serilog.AspNetCore.Tests/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
└── ...

• src/：包含 Serilog 及其各种扩展和接收器的源代码。
  • Serilog/：Serilog 核心库。
  • Serilog.AspNetCore/：用于 ASP.NET Core 的扩展。
  • Serilog.Sinks.Console/：用于将日志输出到控制台的接收器。
• test/：包含各种测试项目，确保代码的正确性。
• .gitignore：Git 忽略文件。
• LICENSE：项目许可证。
• README.md：项目说明文档。

2. 项目的启动文件介绍

Serilog 的启动文件主要涉及在应用程序中配置和启用 Serilog。以下是一个典型的 ASP.NET Core 项目中配置 Serilog 的示例：

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .UseSerilog((context, services, configuration) => configuration
                .ReadFrom.Configuration(context.Configuration)
                .Enrich.FromLogContext()
                .WriteTo.Console())
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

在这个示例中，UseSerilog 方法用于配置 Serilog，包括从配置文件读取配置、丰富日志上下文以及将日志写入控制台。

3. 项目的配置文件介绍

Serilog 的配置可以通过 appsettings.json 文件进行，以下是一个典型的配置示例：

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console" ],
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "WriteTo": [
      { "Name": "Console" }
    ],
    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
    "Properties": {
      "Application": "SampleApp"
    }
  }
}

• Using：指定使用的 Serilog 接收器。
• MinimumLevel：设置日志的最小级别。
• WriteTo：配置日志的输出目标，例如控制台。
• Enrich：配置日志的丰富信息，例如从日志上下文、机器名和线程ID。
• Properties：添加自定义的日志属性。

通过这些配置，可以灵活地控制 Serilog 的日志记录行为。

serilogSimple .NET logging with fully-structured events项目地址:https://gitcode.com/gh_mirrors/se/serilog