Skip to content

Commit 7dc35b1

Browse files
committed
Document server-side gRPC health opt-in behavior
Explain that server-side gRPC health is disabled by default. Update actuator health example to explicitly enable it. Signed-off-by: Andrey Litvitski <[email protected]>
1 parent 6ca5be3 commit 7dc35b1

File tree

1 file changed

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

1 file changed

+3
-0
lines changed

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

Lines changed: 3 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 disabled by default. Set `spring.grpc.server.health.enabled=true` to enable it.
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 (`""`).
@@ -19,6 +21,7 @@ spring:
1921
grpc:
2022
server:
2123
health:
24+
enabled: true
2225
actuator:
2326
health-indicator-paths:
2427
- db

0 commit comments

Comments
 (0)