如何通过代码覆盖appsettings中配置的Serilog Sink属性（ASP.NET Web API）

实现思路 #

• 从密钥管理器（如本地Secret Manager、Azure Key Vault等）动态获取Datadog API密钥
• 在Serilog配置阶段，覆盖appsettings.json中的API密钥配置（或直接不配置该字段）
• 复用appsettings中其他Datadog Sink的配置参数，避免硬编码

具体实现步骤 #

1. 调整appsettings.json配置 #

保留Serilog和Datadog Sink的其他配置，移除或留空apiKey字段：

"Serilog": {
  "MinimumLevel": "Information",
  "WriteTo": [
    {
      "Name": "DatadogLogs",
      "Args": {
        "service": "MyWebApi",
        "host": "ApiProductionHost",
        "source": "AspNetCoreWebApi",
        "endpoint": "https://http-intake.logs.datadoghq.com/v1/input",
        "apiKey": "" // 留空或直接删除该字段
      }
    }
  ]
}

2. 在Program.cs中动态配置Serilog #

以.NET 6+的Top-level Statements为例：

using Serilog;
using Serilog.Sinks.Datadog.Logs;
using Microsoft.Extensions.Configuration;

var builder = WebApplication.CreateBuilder(args);

// 从密钥管理器读取Datadog API密钥
// 本地开发可使用Secret Manager：dotnet user-secrets set "Datadog:ApiKey" "你的密钥"
// 生产环境可集成Azure Key Vault等服务，只需确保Configuration能读取到该值
var datadogApiKey = builder.Configuration["Datadog:ApiKey"] 
    ?? throw new InvalidOperationException("未找到Datadog API密钥，请检查密钥配置");

// 配置Serilog，覆盖API密钥
builder.Host.UseSerilog((context, services, config) =>
{
    config
        .ReadFrom.Configuration(context.Configuration) // 加载appsettings中的基础配置
        .WriteTo.DatadogLogs(
            apiKey: datadogApiKey,
            // 从appsettings读取其他配置参数，避免硬编码
            service: context.Configuration["Serilog:WriteTo:0:Args:service"],
            host: context.Configuration["Serilog:WriteTo:0:Args:host"],
            source: context.Configuration["Serilog:WriteTo:0:Args:source"],
            endpoint: context.Configuration["Serilog:WriteTo:0:Args:endpoint"]
        );
});

// 注册API控制器服务
builder.Services.AddControllers();

var app = builder.Build();

// 配置中间件
app.UseAuthorization();
app.MapControllers();

app.Run();

3. 优化：使用DatadogSinkOptions复用配置 #

如果不想逐个读取配置参数，可以直接绑定到DatadogSinkOptions对象后修改API密钥：

builder.Host.UseSerilog((context, services, config) =>
{
    // 从appsettings读取Datadog Sink的配置
    var datadogOptions = context.Configuration
        .GetSection("Serilog:WriteTo:0:Args")
        .Get<DatadogSinkOptions>() 
        ?? new DatadogSinkOptions();

    // 覆盖API密钥
    datadogOptions.ApiKey = datadogApiKey;

    config
        .ReadFrom.Configuration(context.Configuration)
        .WriteTo.DatadogLogs(datadogOptions);
});

注意事项 #

• 本地开发时，使用dotnet user-secrets命令存储密钥，避免提交到版本控制
• 生产环境需集成企业级密钥管理服务（如Azure Key Vault、HashiCorp Vault等），确保密钥安全
• 确保已安装Serilog.Sinks.Datadog.Logs NuGet包，版本与项目兼容

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