如何将Azure KeyVault单密钥与appSettings合并为IConfiguration供ElasticApm使用

核心思路 #

无需全量加载KeyVault所有密钥，仅单独获取ElasticApm--SecretToken，再将其合并到已加载的AppSettings配置中，既满足app.UseElasticApm的配置需求，又避免内存占用问题。

实现步骤与代码示例 #

1. 加载基础配置（AppSettings）

先通过常规方式加载appsettings.json等配置源，得到包含ElasticApm基础项的配置：

var configBuilder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Production"}.json", optional: true);

IConfiguration baseConfig = configBuilder.Build();

2. 单独获取KeyVault中的指定密钥

利用Azure Key Vault客户端单独拉取目标密钥（注意KeyVault中密钥名称需与配置键对应，后续会映射为ElasticApm:SecretToken）：

// 初始化KeyVault客户端（根据你的认证方式调整，比如ManagedIdentityCredential）
var credential = new DefaultAzureCredential();
var keyVaultClient = new SecretClient(new Uri("https://your-keyvault-name.vault.azure.net/"), credential);

// 获取指定密钥
var secretResponse = await keyVaultClient.GetSecretAsync("ElasticApm--SecretToken");
string secretToken = secretResponse.Value.Value;

3. 合并配置到新的IConfiguration

通过ConfigurationBuilder在基础配置之上添加内存配置源，将密钥值注入到ElasticApm:SecretToken节点：

var mergedConfig = new ConfigurationBuilder()
    .AddConfiguration(baseConfig)
    .AddInMemoryCollection(new Dictionary<string, string>
    {
        { "ElasticApm:SecretToken", secretToken }
    })
    .Build();

4. 使用合并后的配置初始化Elastic APM

将合并后的配置传入app.UseElasticApm即可：

app.UseElasticApm(mergedConfig);

替代优化方案：通过自定义管理器加载单个密钥 #

如果希望借助官方配置提供器机制，但只加载特定密钥，可以自定义IKeyVaultSecretManager实现过滤：

var configBuilder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json")
    .AddAzureKeyVault(
        new Uri("https://your-keyvault-name.vault.azure.net/"),
        new DefaultAzureCredential(),
        new ElasticApmSecretManager());

// 自定义管理器只加载目标密钥
public class ElasticApmSecretManager : IKeyVaultSecretManager
{
    public bool Load(SecretProperties properties)
    {
        // 仅加载名称为ElasticApm--SecretToken的密钥
        return properties.Name.Equals("ElasticApm--SecretToken", StringComparison.OrdinalIgnoreCase);
    }

    public string GetKey(KeyVaultSecret secret)
    {
        // 将KeyVault中的--替换为配置路径分隔符:
        return secret.Name.Replace("--", ":");
    }
}

IConfiguration mergedConfig = configBuilder.Build();
app.UseElasticApm(mergedConfig);

这种方式既利用了官方配置集成能力，又通过过滤避免了全量加载密钥带来的内存问题。

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