Azure容器中ASP.NET Core 3.x Web API读取配置启动失败排查

需要从Azure App Service配置菜单读取environment_stage变量，以此加载对应的appsettings.{ENVIRONMENT_VALUE}.json配置文件。本地IIS和手动Docker运行正常，但添加配置读取代码后，流水线部署的容器启动超时，无法响应端口8000的探测。

现有代码 #

Startup构造函数 #

public Startup(IConfiguration configuration, IWebHostEnvironment env)
{
    HostingEnvironment = env;
    Configuration = new ConfigurationBuilder().AddConfiguration(configuration).AddEnvironmentVariables().Build();
}

ConfigureServices方法 #

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    //get value from azure configuration tab using key provided
    var ENVIRONMENT_VALUE = (string)Configuration["APPSETTING_environment_stage"];

    if (!string.IsNullOrEmpty(ENVIRONMENT_VALUE))
    {
        // Create a new configuration object that uses the app.{ENVIRONMENT_VALUE}.settings file.
        var configurationBuilder = new ConfigurationBuilder()
                    .SetBasePath(HostingEnvironment.ContentRootPath)
                    .AddJsonFile($"appsettings.{ENVIRONMENT_VALUE }.json", optional: false, reloadOnChange: true)
                    .AddEnvironmentVariables();

        // Use this new configuration object to configure your ASP.NET Core application.
        Configuration = configurationBuilder.Build();

        services.AddSingleton(Configuration);
    }

    // ... more code ...
}

错误日志 #

2023-07-20T16:41:18.926Z INFO  - Pull Image successful, Time taken: 0 Minutes
 and 0 Seconds
2023-07-20T16:41:18.949Z INFO  - Starting container for site
2023-07-20T16:41:18.949Z INFO  - docker run -d --expose=8000 .... 

2023-07-20T16:41:18.956Z INFO  - Logging is not enabled for this container.
Please use https://aka.ms/linux-diagnostics to enable logging to see container logs here.
2023-07-20T16:41:20.573Z INFO  - Initiating warmup request to container XXXXX_1_XXXX for site XXXXXX

2023-07-20T16:41:35.760Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 15.186126 sec
2023-07-20T16:41:50.874Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 30.3010628 sec
2023-07-20T16:42:05.967Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 45.3936879 sec
2023-07-20T16:42:23.631Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 63.0572676 sec
2023-07-20T16:42:38.775Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 78.2018833 sec
2023-07-20T16:42:56.688Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 96.1147642 sec
2023-07-20T16:43:12.831Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 112.2574577 sec
2023-07-20T16:43:28.136Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 127.5626406 sec
2023-07-20T16:43:43.253Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 142.6797184 sec
2023-07-20T16:43:58.400Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 157.8269513 sec
2023-07-20T16:44:13.576Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 173.0025816 sec
2023-07-20T16:44:33.131Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 192.5576124 sec
2023-07-20T16:44:51.136Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 210.5624924 sec
2023-07-20T16:45:06.308Z INFO  - Waiting for response to warmup request for container XXX_1_XXX. Elapsed time = 225.735017 sec
2023-07-20T16:45:11.364Z ERROR - Container XXX_1_XXX for site XXX did not start within expected time limit. Elapsed time = 230.7901186 sec
2023-07-20T16:45:11.382Z ERROR - Container XXX_1_XXX didn't respond to HTTP pings on port: 8000, failing site start. See container logs for debugging.
2023-07-20T16:45:11.390Z INFO  - Stopping site XXX because it failed during startup.

问题根源 #

1. 配置文件路径空格问题：代码中$"appsettings.{ENVIRONMENT_VALUE }.json"的ENVIRONMENT_VALUE后多了一个空格，导致实际加载的文件名带空格，容器中无对应文件，optional: false会抛出异常阻塞启动。
2. 配置替换时机错误：在ConfigureServices中重新构建并替换全局Configuration实例，会导致后续依赖IConfiguration的服务获取配置不完整，引发初始化冲突。
3. Azure配置键名错误：Azure App Service应用设置无需手动加APPSETTING_前缀，IConfiguration已自动处理映射，直接用environment_stage即可读取。

修复方案 #

1. 修正配置文件路径空格 #

将$"appsettings.{ENVIRONMENT_VALUE }.json"改为$"appsettings.{ENVIRONMENT_VALUE}.json"，移除变量后的空格。

2. 调整配置加载时机到Program.cs #

ASP.NET Core推荐在Program.cs完成配置初始化，避免在ConfigureServices中替换全局配置：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((context, config) =>
        {
            // 读取Azure配置中的environment_stage
            var envStage = config.Build()["environment_stage"];
            if (!string.IsNullOrEmpty(envStage))
            {
                config.AddJsonFile($"appsettings.{envStage}.json", optional: false, reloadOnChange: true);
            }
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

3. 修正Azure配置键名读取 #

直接使用Configuration["environment_stage"]，无需添加APPSETTING_前缀。

4. 简化Startup构造函数 #

删除多余的ConfigurationBuilder，直接使用注入的IConfiguration：

public Startup(IConfiguration configuration, IWebHostEnvironment env)
{
    HostingEnvironment = env;
    Configuration = configuration;
}

5. 确保容器包含对应环境配置文件 #

确认Docker镜像中已打包appsettings.SIT.json等环境配置文件，避免文件缺失。

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