Serilog 设置配置教程

Serilog 设置配置教程

项目地址:https://gitcode.com/gh_mirrors/se/serilog-settings-configuration

本教程将引导你了解 Serilog 的设置配置库 Serilog.Settings.Configuration，该库允许你使用 .NET Core 的 appsettings.json 文件或其他配置源来配置 Serilog。

1. 项目目录结构及介绍

在 Serilog.Settings.Configuration 中，主要的代码和样例分布在以下几个目录中：

• sample: 包含一个使用 Serilog.Settings.Configuration 样例应用程序。
• src: 存放主库的源代码。
• test: 测试代码所在位置。
• appveyor.yml: 持续集成配置。
• global.json: .NET CLI 配置文件。
• Build.ps1: PowerShell 构建脚本。
• CHANGES.md: 版本变更历史记录。
• .editorconfig: 代码风格配置。
• .gitignore 和 .gitattributes: Git 相关配置。
• License.md: 许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

虽然 Serilog.Settings.Configuration 是一个库，不包含传统的可执行程序，但其示例项目 (sample) 提供了一个如何使用库的起点。在示例项目中，Program.cs 文件是主要的入口点，它展示了如何配置并初始化一个基于外部配置的 Serilog 日志器。核心代码通常会包括以下步骤：

using System.IO;
using Microsoft.Extensions.Configuration;
using Serilog;

public class Program
{
    public static void Main()
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(Directory.GetCurrentDirectory())
            .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
        IConfigurationRoot configuration = builder.Build();

        var loggerConfig = new LoggerConfiguration();
        loggerConfig.ReadFrom.Configuration(configuration);

        Log.Logger = loggerConfig.CreateLogger();

        // 使用日志
        Log.Information("应用已启动");

        // 应用逻辑...
    }
}

这段代码创建了 IConfigurationRoot 对象，然后通过 ReadFrom.Configuration() 方法加载配置到 Serilog。

3. 项目的配置文件介绍

配置文件通常指的是 appsettings.json，其中包含 Serilog 的配置节。例如：

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.File" ],
    "MinimumLevel": "Debug",
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "File",
        "Args": {
          "path": "Logs/log.txt",
          "rollingInterval": "Day"
        }
      }
    ]
  }
}

在这个例子中：

• "Using" 字段指定了要使用的日志接收器（Sinks），如 Console 和 File。
• "MinimumLevel" 定义了最低的日志级别。
• "WriteTo" 字段定义了日志输出的目标。在这里，日志被写入控制台和文件。

你可以根据需求自定义这个配置文件，调整日志级别、添加更多接收器或自定义接收器的参数。

总结，Serilog.Settings.Configuration 是一个强大的工具，使你的 Serilog 配置更灵活，易于维护，且能够无缝融入 .NET Core 应用的现有配置框架。

serilog-settings-configuration A Serilog configuration provider that reads from Microsoft.Extensions.Configuration 项目地址: https://gitcode.com/gh_mirrors/se/serilog-settings-configuration