Skip to content

Commit cbfbdbf

Browse files
committed
Clarify default server-side gRPC health behavior
Document that server-side gRPC health is enabled by default only when a BindableService is present. Signed-off-by: Andrey Litvitski <andrey1010102008@gmail.com>
1 parent 4983d3c commit cbfbdbf

File tree

1 file changed

+2
-0
lines changed
  • spring-grpc-docs/src/main/antora/modules/ROOT/pages

1 file changed

+2
-0
lines changed

spring-grpc-docs/src/main/antora/modules/ROOT/pages/health.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ The health service is registered with the gRPC server and a `HealthStatusManager
77

88
IMPORTANT: The health service resides in the `io.grpc:grpc-services` library which is marked as `optional` by Spring gRPC. You must add this dependency to your application in order for it to be autoconfigured.
99

10+
NOTE: Server-side gRPC health is enabled by default when the application defines at least one `BindableService`. If no server-side gRPC services are present, health is disabled by default and must be explicitly enabled using `spring.grpc.server.health.enabled=true`.
11+
1012
== Actuator Health
1113
When Spring Boot Actuator is added to your project and the {spring-boot-docs}/actuator/endpoints.html#actuator.endpoints.health[Health endpoint] is available, the framework will automatically periodically update the health status of a configured list of Spring Boot {spring-boot-docs}/actuator/endpoints.html#actuator.endpoints.health.auto-configured-health-indicators[health indicators], including any ({spring-boot-docs}/actuator/endpoints.html#actuator.endpoints.health.writing-custom-health-indicators[custom indicators]).
1214
By default, the aggregate status of the individual indicators is also used to update the overall server status (`""`).

0 commit comments

Comments
 (0)