从Azure KeyVault取密钥设环境变量后，Elastic APM无法读取配置的问题

我尝试从Azure KeyVault获取密钥并设置为环境变量（避免从appsettings.json读取），代码中已成功获取密钥，但调用app.UseAllElasticApm(builder.Configuration)时无法正确读取配置。需求是将appsettings中的ServiceName与KeyVault获取的Url、Token合并到builder.Configuration中供Elastic APM使用，请问缺失了什么步骤？

代码示例 #

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);
    
    var app = builder.RegisterServices().Build();

    var client = new SecretClient(new Uri(Environment.GetEnvironmentVariable("KeyStoreUrl") ?? string.Empty), new DefaultAzureCredential());
    var url = client.GetSecret("APM--Url").Value.Value;
    var token = client.GetSecret("APM--Token").Value.Value;

    Environment.SetEnvironmentVariable("APM--Url", url);
    Environment.SetEnvironmentVariable("APM--Token", token);

    builder.Configuration.AddEnvironmentVariables(prefix: "APM");
    
    app.UseAllElasticApm(builder.Configuration);

    app.Run();
}

appsettings配置示例 #

"APM": {
"Url": "XXXXXXXXX",
"Token": "XXXXXX",
"ServiceName": "Sample"
}

你当前代码的核心问题在于配置加载时机错误，以及环境变量的处理不符合.NET配置系统规则，具体缺失和调整点如下：

• 调整代码执行顺序：你在builder.Build()创建app实例后才修改配置、添加环境变量，此时builder.Configuration已经被固化到app的服务容器中，后续修改不会同步到已构建的app里。必须在builder.Build()之前完成所有配置的修改和加载。

• 修正环境变量分隔符：.NET配置系统中，环境变量的层级分隔符是双下划线__，不是你用的单破折号--。设置环境变量时要用APM__Url格式，这样AddEnvironmentVariables才能正确解析为APM:Url配置项。

• 利用配置源优先级自动合并：.NET配置系统会自动按优先级覆盖配置项（后添加的配置源优先级更高），不需要手动处理合并逻辑，只要把KeyVault的配置源加在appsettings之后即可。

调整后的代码（推荐使用内置KeyVault配置提供器） #

这种方式更符合.NET配置系统的设计，无需手动处理密钥获取和环境变量：

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);

    // 1. 添加Azure KeyVault作为配置源，自动合并appsettings的ServiceName和KeyVault的Url、Token
    var keyVaultUrl = Environment.GetEnvironmentVariable("KeyStoreUrl");
    if (!string.IsNullOrEmpty(keyVaultUrl))
    {
        builder.Configuration.AddAzureKeyVault(
            new Uri(keyVaultUrl),
            new DefaultAzureCredential(),
            new KeyVaultSecretManager());
    }

    // 2. 所有配置准备完成后，再构建app
    var app = builder.RegisterServices().Build();

    // 3. 使用合并后的配置初始化Elastic APM
    app.UseAllElasticApm(builder.Configuration);

    app.Run();
}

// 自定义密钥管理器，将KeyVault中的"APM--Url"映射为配置系统的"APM:Url"
public class KeyVaultSecretManager : IKeyVaultSecretManager
{
    public bool Load(SecretProperties properties) => properties.Name.StartsWith("APM--");

    public string GetKey(KeyVaultSecret secret)
    {
        return secret.Name.Replace("--", ":");
    }
}

若坚持手动设置环境变量的调整版本 #

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);

    // 1. 先获取KeyVault密钥并设置正确格式的环境变量
    var client = new SecretClient(new Uri(Environment.GetEnvironmentVariable("KeyStoreUrl") ?? string.Empty), new DefaultAzureCredential());
    var url = client.GetSecret("APM--Url").Value.Value;
    var token = client.GetSecret("APM--Token").Value.Value;

    Environment.SetEnvironmentVariable("APM__Url", url); // 用双下划线作为层级分隔符
    Environment.SetEnvironmentVariable("APM__Token", token);

    // 2. 添加环境变量配置源，读取刚设置的环境变量
    builder.Configuration.AddEnvironmentVariables(prefix: "APM");

    // 3. 配置完成后再构建app
    var app = builder.RegisterServices().Build();

    // 4. 初始化Elastic APM
    app.UseAllElasticApm(builder.Configuration);

    app.Run();
}

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