如何为多环境的appsettings.json配置Serilog日志服务

结论 #

你当前的自定义多环境节点配置方案技术上可以正常运行，但属于非标准实现，存在配置冗余、维护成本高、不符合.NET生态开发惯例的问题，更推荐使用.NET原生的多环境配置机制实现。

现有方案的核心问题 #

• 配置重复度极高：Serilog的通用规则（比如最低日志级别、Console输出配置、引入的Sink包）在每个环境节点下都重复编写，后续修改通用规则需要同步修改所有环境的配置，很容易出现不一致的问题
• 额外增加代码复杂度：需要自己写逻辑解析启动参数、手动切换对应环境的Serilog配置节点，没必要做额外的自定义开发
• 不符合通用开发规范：.NET生态本身有成熟的多环境配置解决方案，自定义规则会提升后续接手项目的开发人员的理解成本

标准实现方案 #

第一步：拆分多环境配置文件 #

不需要把所有环境的配置都塞到同一个appsettings.json里，按环境拆分配置文件即可：

• 基础通用配置文件：appsettings.json，存放所有环境共用的Serilog配置
• Dev环境配置文件：appsettings.d.json（对应你要的缩写标识d）
• UAT环境配置文件：appsettings.q.json（对应你要的缩写标识q）
• Prod环境配置文件：appsettings.p.json

示例通用配置appsettings.json内容：

"Serilog": {
  "MinimumLevel": "Verbose",
  "Using": [
    "Serilog.Sinks.Console",
    "Serilog.Sinks.Seq"
  ],
  "WriteTo": [
    {
      "Name": "Console"
    },
    {
      "Name": "Seq",
      "Args": {
        "serverUrl": ""
      },
      "Properties": {
        "Application": "Console.Sample",
        "Environment": ""
      }
    }
  ]
}

示例Dev环境差异化配置appsettings.d.json内容，只需要覆盖和通用配置不一样的字段即可，没有冗余：

"Serilog": {
  "WriteTo": [
    {
      "Name": "Seq",
      "Args": {
        "serverUrl": "https://seq-dev.test.com"
      },
      "Properties": {
        "Environment": "Development"
      }
    }
  ]
}

第二步：启动时指定环境，自动加载对应配置 #

不需要自己写代码解析环境参数，.NET配置系统原生支持启动时指定环境，自动加载对应的配置文件，启动时传入参数即可：

# 启动Dev环境，自动加载appsettings.d.json
yourApp.exe --environment d
# 启动UAT环境，自动加载appsettings.q.json
yourApp.exe --environment q

第三步：Serilog直接读取根配置即可 #

不需要手动切节点，直接从默认加载的配置根节点读取Serilog配置即可：

// 加载多环境配置，.NET 6+ 顶部语句写法，不同版本写法逻辑一致
var builder = Host.CreateDefaultBuilder(args);
builder.UseSerilog((context, config) =>
{
    config.ReadFrom.Configuration(context.Configuration);
});

标准方案的优势 #

• 零配置冗余：通用规则只写一次，每个环境只需要维护差异化参数，修改成本极低
• 不需要自定义开发逻辑：完全复用.NET原生能力，代码量更少，出问题概率更低
• 符合通用开发规范：所有.NET开发人员都熟悉这套机制，项目接手、迭代成本更低

内容的提问来源于stack exchange，提问作者cpage