From ae8ec86486092f6f56061d316de6bd88794f0af7 Mon Sep 17 00:00:00 2001 From: Moritz Halbritter Date: Wed, 23 Nov 2022 14:21:51 +0100 Subject: [PATCH] Clarify startup probe in actuator documentation Closes gh-28432 --- .../src/docs/asciidoc/actuator/endpoints.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc index 48d806012608..dfd5e4db951e 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc @@ -1016,7 +1016,10 @@ These health groups are automatically enabled only if the application <>. +Generally speaking, the `"startupProbe"` is not necessarily needed here, as the `"readinessProbe"` fails until all startup tasks are done. +This means your application will not receive traffic until it is ready. +However, if your application takes a long time to start, consider using a `"startupProbe"` to make sure that Kubernetes won't kill your application while it is in the process of starting. +See the section that describes <>. If your Actuator endpoints are deployed on a separate management context, the endpoints do not use the same web infrastructure (port, connection pools, framework components) as the main application. In this case, a probe check could be successful even if the main application does not work properly (for example, it cannot accept new connections).