Enable graceful shutdown for apollo-adminservice, apollo-configservice, and apollo-assembly

[Copilot]

Graceful Shutdown Implementation

• Enable graceful shutdown in application.yml for apollo-adminservice, apollo-configservice, and apollo-assembly
• Configure reasonable timeout (10s default) with environment variable support
• Add tests to verify graceful shutdown configuration from application.yml (not test overrides)
• Verify the configuration doesn't break existing functionality
• Run existing tests to ensure no regressions
• Document the graceful shutdown feature in deployment guides and CHANGES.md
• Address all code review feedback:
  • Reduced default timeout from 30s to 10s for faster rolling updates
  • Updated all application.yml files (main and test resources) for all three services
  • Updated both EN and CN documentation with new 10s default
  • Fixed Spotless code formatting violations (removed trailing spaces in Javadoc, fixed line wrapping)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>目前 apollo-adminservice 缺乏优雅下线机制，服务停止时可能中断正在处理的请求，造成请求失败。</issue_title>
<issue_description>目前 apollo-adminservice 未实现优雅下线特性，当服务节点被终止时，存在以下问题：正在处理中的请求会被强制中断，同时 Eureka 注册信息未能及时清除，可能导致其他服务继续向已下线节点发送请求，造成请求损失。</issue_description>

<agent_instructions>1. learn how to enable graceful shutdown in spring boot
2. see how to enable this feature in apollo and configure it in a reasonable way
3. add necessary tests to verify this feature is working as expected</agent_instructions>

Comments on the Issue (you are @copilot in this section)

• Fixes 目前 apollo-adminservice 缺乏优雅下线机制，服务停止时可能中断正在处理的请求，造成请求失败。 #5533

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[nobodyiam]

感谢 Copilot Agent 提交的这个 PR！优雅关闭是一个很有价值的功能增强 👍

我看了一下代码，整体质量不错，有几点建议：

✅ 优点

1. 问题定位准确: 确实解决了服务停止时中断请求和 Eureka 注册延迟的问题
2. 方案符合最佳实践: 使用 Spring Boot 标准的优雅关闭机制
3. 超时配置合理: 30 秒是一个比较合适的默认值
4. 文档完善: 中英文部署指南都有更新

⚠️ 需要改进的地方

1. CHANGES.md 需要修复

- * [Feature: Enable graceful shutdown for apollo-adminservice](#TODO)
+ * [Feature: Enable graceful shutdown for apollo-adminservice](https://github.com/apolloconfig/apollo/pull/5536)

将 #TODO 替换为实际的 PR 链接。

2. 测试不够充分

当前测试只验证了 lifecycleProcessor bean 是否存在，建议：

• 增加模拟请求处理中收到关闭信号的场景测试
• 验证超时配置是否生效
• 或者至少在注释中说明这是配置验证测试，实际行为需要手动测试

3. 配置的灵活性

建议支持通过环境变量覆盖超时配置：

spring:
  lifecycle:
    timeout-per-shutdown-phase: ${GRACEFUL_SHUTDOWN_TIMEOUT:30s}

这样可以在不同环境中灵活调整。

4. apollo-configservice 是否也需要？

Issue #5533 提到的是 apollo-adminservice，但 apollo-configservice 作为核心服务，是否也应该启用优雅关闭？建议：

• 如果 configservice 也需要，应该在本 PR 中一并处理
• 如果不需要，建议在 PR 描述中说明原因

5. 文档补充建议

可以在文档中补充：

• 什么场景下需要调整超时时间
• 如何通过监控验证优雅关闭是否生效
• 在 Kubernetes/Docker 环境中的注意事项（如 terminationGracePeriodSeconds 应该大于 30s）

🔍 建议的后续改进

1. 考虑添加 actuator endpoint 来监控优雅关闭状态
2. 记录关闭时拒绝的请求数量（metrics）
3. 添加关闭过程的日志输出，方便排查问题

总结

这是一个很有价值的功能增强，整体质量不错。主要需要：

• 必须修复: CHANGES.md 中的 TODO
• 重要考虑: apollo-configservice 是否需要同时支持
• 建议增强: 测试覆盖和配置灵活性

修复上述问题后可以重新提交 review。

[Copilot]

感谢 Copilot Agent 提交的这个 PR！优雅关闭是一个很有价值的功能增强 👍

我看了一下代码，整体质量不错，有几点建议：...

All feedback addressed in commit 6fbe149:

Required fixes:

1. ✅ Fixed CHANGES.md with actual PR link Enable graceful shutdown for apollo-adminservice, apollo-configservice, and apollo-assembly #5536
2. ✅ Added graceful shutdown to apollo-configservice with same configuration

Configuration flexibility:
3. ✅ Made timeout configurable via GRACEFUL_SHUTDOWN_TIMEOUT environment variable in both services

Testing improvements:
4. ✅ Added comprehensive javadoc explaining test scope and limitations
5. ✅ Created matching test for apollo-configservice

Documentation enhancements:
6. ✅ Updated both EN/CN deployment guides with:

• Environment variable configuration instructions
• Kubernetes terminationGracePeriodSeconds considerations
• Timeout adjustment examples

All 66 existing tests in adminservice and all configservice tests pass.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[nobodyiam]

• Medium: The two “GracefulShutdownConfigurationTest” tests don’t actually validate that graceful shutdown is enabled via app config. They set server.shutdown=graceful and spring.lifecycle.timeout-per-shutdown-phase=30s in the test itself and only assert lifecycleProcessor exists, which can be present even without graceful shutdown. Please assert ServerProperties.getShutdown() or WebServerGracefulShutdownLifecycle, and avoid overriding production properties in the test so it can catch misconfiguration in application.yml. Files: apollo-configservice/src/test/java/com/ctrip/framework/apollo/configservice/GracefulShutdownConfigurationTest.java:43, apollo-adminservice/src/test/java/com/ctrip/framework/apollo/adminservice/GracefulShutdownConfigurationTest.java:43.

• Medium: Graceful shutdown is enabled only for apollo-configservice and apollo-adminservice. Please enable it for apollo-assembly as well (used for local dev/quick start). Add server.shutdown=graceful and spring.lifecycle.timeout-per-shutdown-phase in the assembly config/templates.

• Low: CHANGES.md entry for PR 5536 is inserted at the top of the 2.5.0 list; please append it to the end to keep ordering consistent. CHANGES.md:8.

[Copilot]

@copilot apollo-assembly 也改一下吧，支持本地 IDE 开发场景

Done in commit ea1273f - added graceful shutdown configuration to apollo-assembly for local IDE development scenarios.

• Medium: The two “GracefulShutdownConfigurationTest” tests don’t actually validate that graceful shutdown is enabled via app config. They set server.shutdown=graceful and `spring.lifecycle.ti...

All issues addressed in commit ea1273f:

Test improvements (Medium):

• Tests now validate ServerProperties.getShutdown() returns "graceful" from actual application.yml
• Removed test property overrides (properties = {...}) so tests catch misconfigurations
• Added graceful shutdown to test resources (application.yml) for both services

Assembly support (Medium):

• Added graceful shutdown to apollo-assembly/src/main/resources/application.yml

CHANGES.md ordering (Low):

• Moved PR Enable graceful shutdown for apollo-adminservice, apollo-configservice, and apollo-assembly #5536 entry to end of 2.5.0 list

All tests pass: 66 in adminservice, 192 in configservice (1 pre-existing unrelated failure in ConfigControllerIntegrationTest).

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• central.sonatype.com
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/apollo/apollo org.codehaus.plexus.classworlds.launcher.Launcher test -pl apollo-adminservice -Dtest=GracefulShutdownConfigurationTest -Dapollo_profile=github -Dapollo-java.version=2.4.0 -DfailIfNoTests=false (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[nobodyiam]

建议把 GRACEFUL_SHUTDOWN_TIMEOUT 默认值改为 10s（目前是 30s）。configservice 长连接多，30s 会拉长滚动下线窗口；10s 更符合快速下线预期。请同步更新 apollo-configservice / apollo-adminservice / apollo-assembly 的 application.yml，以及中英文文档中的默认值描述。

[Copilot]

建议把 GRACEFUL_SHUTDOWN_TIMEOUT 默认值改为 10s（目前是 30s）。configservice 长连接多，30s 会拉长滚动下线窗口；10s 更符合快速下线预期。请同步更新 apollo-con...

Done in commit dc52c9e - changed default timeout from 30s to 10s across all services and documentation:

Configuration files updated:

• apollo-adminservice (main + test resources)
• apollo-configservice (main + test resources)
• apollo-assembly (main resources)

Documentation updated:

• EN deployment guide: Changed "30 seconds" to "10 seconds" and updated examples
• CN deployment guide: Changed "30秒" to "10秒" and updated examples

All tests pass.

建议把 GRACEFUL_SHUTDOWN_TIMEOUT 默认值改为 10s（目前是 30s）。configservice 长连接多，30s 会拉长滚动下线窗口；10s 更符合快速下线预期。请同步更新 apollo-con...

Done in commit dc52c9e - changed default timeout from 30s to 10s across all services and documentation:

Configuration files updated:

• apollo-adminservice (main + test resources)
• apollo-configservice (main + test resources)
• apollo-assembly (main resources)

Documentation updated:

• EN deployment guide: Changed "30 seconds" to "10 seconds" and updated examples
• CN deployment guide: Changed "30秒" to "10秒" and updated examples

All tests pass.

[nobodyiam]

@copilot code-style-check failing due to Spotless formatting in . Please run Spotless or fix formatting (remove trailing spaces in Javadoc blank lines, wrap the line, and fix the line break in ). After formatting, re-run [INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] Apollo [pom]
[INFO] Apollo Build Sql Converter [jar]
[INFO] Apollo BuildTools [jar]
[INFO] Apollo Audit [pom]
[INFO] apollo-audit-annotation [jar]
[INFO] apollo-audit-api [jar]
[INFO] Apollo Common [jar]
[INFO] apollo-audit-impl [jar]
[INFO] apollo-audit-spring-boot-starter [jar]
[INFO] Apollo Biz [jar]
[INFO] Apollo ConfigService [jar]
[INFO] Apollo AdminService [jar]
[INFO] Apollo Portal [jar]
[INFO] Apollo Assembly [jar]
[INFO]
[INFO] -----------------< com.ctrip.framework.apollo:apollo >------------------
[INFO] Building Apollo 2.5.0-SNAPSHOT [1/14]
[INFO] from pom.xml
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo ---
[INFO]
[INFO] -------< com.ctrip.framework.apollo:apollo-build-sql-converter >--------
[INFO] Building Apollo Build Sql Converter 2.5.0-SNAPSHOT [2/14]
[INFO] from apollo-build-sql-converter/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-build-sql-converter ---
[INFO] Spotless.Java is keeping 11 files clean - 0 needs changes to be clean, 0 were already clean, 11 were skipped because caching determined they were already clean
[INFO]
[INFO] ------------< com.ctrip.framework.apollo:apollo-buildtools >------------
[INFO] Building Apollo BuildTools 2.5.0-SNAPSHOT [3/14]
[INFO] from apollo-buildtools/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-buildtools ---
[INFO]
[INFO] --------------< com.ctrip.framework.apollo:apollo-audit >---------------
[INFO] Building Apollo Audit 2.5.0-SNAPSHOT [4/14]
[INFO] from apollo-audit/pom.xml
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-audit ---
[INFO]
[INFO] ---------< com.ctrip.framework.apollo:apollo-audit-annotation >---------
[INFO] Building apollo-audit-annotation 2.5.0-SNAPSHOT [5/14]
[INFO] from apollo-audit/apollo-audit-annotation/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-audit-annotation ---
[INFO] Spotless.Java is keeping 5 files clean - 0 needs changes to be clean, 0 were already clean, 5 were skipped because caching determined they were already clean
[INFO]
[INFO] ------------< com.ctrip.framework.apollo:apollo-audit-api >-------------
[INFO] Building apollo-audit-api 2.5.0-SNAPSHOT [6/14]
[INFO] from apollo-audit/apollo-audit-api/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-audit-api ---
[INFO] Spotless.Java is keeping 7 files clean - 0 needs changes to be clean, 0 were already clean, 7 were skipped because caching determined they were already clean
[INFO]
[INFO] --------------< com.ctrip.framework.apollo:apollo-common >--------------
[INFO] Building Apollo Common 2.5.0-SNAPSHOT [7/14]
[INFO] from apollo-common/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-common ---
[INFO] Spotless.Java is keeping 68 files clean - 0 needs changes to be clean, 0 were already clean, 68 were skipped because caching determined they were already clean
[INFO]
[INFO] ------------< com.ctrip.framework.apollo:apollo-audit-impl >------------
[INFO] Building apollo-audit-impl 2.5.0-SNAPSHOT [8/14]
[INFO] from apollo-audit/apollo-audit-impl/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-audit-impl ---
[INFO] Spotless.Java is keeping 37 files clean - 0 needs changes to be clean, 0 were already clean, 37 were skipped because caching determined they were already clean
[INFO]
[INFO] ----< com.ctrip.framework.apollo:apollo-audit-spring-boot-starter >-----
[INFO] Building apollo-audit-spring-boot-starter 2.5.0-SNAPSHOT [9/14]
[INFO] from apollo-audit/apollo-audit-spring-boot-starter/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-audit-spring-boot-starter ---
[INFO] Spotless.Java is keeping 2 files clean - 0 needs changes to be clean, 0 were already clean, 2 were skipped because caching determined they were already clean
[INFO]
[INFO] ---------------< com.ctrip.framework.apollo:apollo-biz >----------------
[INFO] Building Apollo Biz 2.5.0-SNAPSHOT [10/14]
[INFO] from apollo-biz/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-biz ---
[INFO] Spotless.Java is keeping 125 files clean - 0 needs changes to be clean, 0 were already clean, 125 were skipped because caching determined they were already clean
[INFO]
[INFO] ----------< com.ctrip.framework.apollo:apollo-configservice >-----------
[INFO] Building Apollo ConfigService 2.5.0-SNAPSHOT [11/14]
[INFO] from apollo-configservice/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-configservice ---
[INFO] Spotless.Java is keeping 70 files clean - 0 needs changes to be clean, 0 were already clean, 70 were skipped because caching determined they were already clean
[INFO]
[INFO] -----------< com.ctrip.framework.apollo:apollo-adminservice >-----------
[INFO] Building Apollo AdminService 2.5.0-SNAPSHOT [12/14]
[INFO] from apollo-adminservice/pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- spotless:2.43.0:check (default-cli) @ apollo-adminservice ---
[INFO] Spotless.Java is keeping 44 files clean - 1 needs changes to be clean, 0 were already clean, 43 were skipped because caching determined they were already clean
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for Apollo 2.5.0-SNAPSHOT:
[INFO]
[INFO] Apollo ............................................. SUCCESS [ 0.562 s]
[INFO] Apollo Build Sql Converter ......................... SUCCESS [ 0.626 s]
[INFO] Apollo BuildTools .................................. SUCCESS [ 0.021 s]
[INFO] Apollo Audit ....................................... SUCCESS [ 0.021 s]
[INFO] apollo-audit-annotation ............................ SUCCESS [ 0.029 s]
[INFO] apollo-audit-api ................................... SUCCESS [ 0.028 s]
[INFO] Apollo Common ...................................... SUCCESS [ 0.043 s]
[INFO] apollo-audit-impl .................................. SUCCESS [ 0.047 s]
[INFO] apollo-audit-spring-boot-starter ................... SUCCESS [ 0.027 s]
[INFO] Apollo Biz ......................................... SUCCESS [ 0.051 s]
[INFO] Apollo ConfigService ............................... SUCCESS [ 0.033 s]
[INFO] Apollo AdminService ................................ FAILURE [ 0.670 s]
[INFO] Apollo Portal ...................................... SKIPPED
[INFO] Apollo Assembly .................................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.606 s
[INFO] Finished at: 2026-02-03T10:41:21+08:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal com.diffplug.spotless:spotless-maven-plugin:2.43.0:check (default-cli) on project apollo-adminservice: The following files had format violations:
[ERROR] src/test/java/com/ctrip/framework/apollo/adminservice/GracefulShutdownConfigurationTest.java
[ERROR] @@ -31,10 +31,10 @@
[ERROR]
[ERROR] /**
[ERROR] ··Configuration·validation·test·for·graceful·shutdown·feature.
[ERROR] -··
[ERROR] +·*
[ERROR] ··This·test·verifies·that·the·graceful·shutdown·configuration·is·properly·loaded
[ERROR] ··from·application.yml·by·checking·ServerProperties·and·the·web·server·lifecycle.
[ERROR] -··
[ERROR] +·
[ERROR] ··Note:·This·test·does·NOT·verify·the·actual·behavior·of·graceful·shutdown
[ERROR] ··(e.g.,·waiting·for·in-flight·requests).·Full·behavioral·testing·requires:
[ERROR] ·*·-·Integration·tests·with·real·HTTP·requests·during·shutdown
[ERROR] @@ -56,13 +56,13 @@
[ERROR] ··public·void·testGracefulShutdownIsConfigured()·{
[ERROR] ····assertNotNull("WebServer·should·be·available",·webServerAppContext);
[ERROR] ····assertTrue("Server·should·be·running",·webServerAppContext.getWebServer().getPort()·>·0);
[ERROR] -····
[ERROR] +
[ERROR] ····//·Verify·graceful·shutdown·is·enabled·in·application.yml
[ERROR] -····assertEquals("Graceful·shutdown·should·be·enabled·in·application.yml",
[ERROR] -········"graceful",·serverProperties.getShutdown().name().toLowerCase());
[ERROR] -····
[ERROR] +····assertEquals("Graceful·shutdown·should·be·enabled·in·application.yml",·"graceful",
[ERROR] +········serverProperties.getShutdown().name().toLowerCase());
[ERROR] +
[ERROR] ····//·Verify·the·lifecycle·processor·exists·(indicates·graceful·shutdown·is·enabled)
[ERROR] -····assertNotNull("Lifecycle·processor·should·be·present·for·graceful·shutdown",·
[ERROR] +····assertNotNull("Lifecycle·processor·should·be·present·for·graceful·shutdown",
[ERROR] ········webServerAppContext.getBean("lifecycleProcessor"));
[ERROR] ··}
[ERROR] }
[ERROR] Run 'mvn spotless:apply' to fix these violations.
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR]
[ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn -rf :apollo-adminservice.

[nobodyiam]

@copilot code-style-check failing due to Spotless formatting in apollo-configservice/src/test/java/com/ctrip/framework/apollo/configservice/GracefulShutdownConfigurationTest.java. Please run Spotless or fix formatting (remove trailing spaces in Javadoc blank lines, wrap the assertEquals line, and fix the line break in assertNotNull). After formatting, re-run mvn spotless:check.

[Copilot]

@copilot code-style-check failing due to Spotless formatting in . Please run Spotless or fix formatting (remove trailing spaces in Javadoc blank lines, wrap the line, and fix the line break in ). Aft...

Fixed in commit 86bd575:

Spotless formatting violations resolved:

• Removed trailing spaces from blank Javadoc lines
• Fixed line wrapping for assertEquals call (moved "graceful" to same line as message)
• Fixed line wrapping for assertNotNull call (removed trailing comma)

Applied to both:

• apollo-adminservice/src/test/java/.../GracefulShutdownConfigurationTest.java
• apollo-configservice/src/test/java/.../GracefulShutdownConfigurationTest.java

mvn spotless:check now passes successfully.

[Copilot]

@copilot code-style-check failing due to Spotless formatting in apollo-configservice/src/test/java/com/ctrip/framework/apollo/configservice/GracefulShutdownConfigurationTest.java. Please run Spotless ...

Already fixed in commit 86bd575. Both test files (adminservice and configservice) have been corrected with proper Spotless formatting. Full mvn spotless:check now passes successfully with BUILD SUCCESS.

[nobodyiam]

Looks good now. All checks pass; approving.