Skip to content

Commit ae8ec86

Browse files
committed
Clarify startup probe in actuator documentation
Closes gh-28432
1 parent 92ed0dc commit ae8ec86

File tree

1 file changed

+4
-1
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator

1 file changed

+4
-1
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1016,7 +1016,10 @@ These health groups are automatically enabled only if the application <<deployme
10161016
You can enable them in any environment by using the configprop:management.endpoint.health.probes.enabled[] configuration property.
10171017

10181018
NOTE: If an application takes longer to start than the configured liveness period, Kubernetes mentions the `"startupProbe"` as a possible solution.
1019-
The `"startupProbe"` is not necessarily needed here, as the `"readinessProbe"` fails until all startup tasks are done. See the section that describes <<actuator#actuator.endpoints.kubernetes-probes.lifecycle,how probes behave during the application lifecycle>>.
1019+
Generally speaking, the `"startupProbe"` is not necessarily needed here, as the `"readinessProbe"` fails until all startup tasks are done.
1020+
This means your application will not receive traffic until it is ready.
1021+
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.
1022+
See the section that describes <<actuator#actuator.endpoints.kubernetes-probes.lifecycle,how probes behave during the application lifecycle>>.
10201023

10211024
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.
10221025
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).

0 commit comments

Comments
 (0)