Skip to content

Commit 211bd43

Browse files
committed
docs
1 parent 80bb4fc commit 211bd43

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/en/actuator.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This page focuses on the integration with
77
This is an optional feature. Supported features:
88

99
- Client + server metrics
10-
- Server `InfoContributor`
10+
- Server `InfoContributor` and `GRPC Health API`
1111

1212
## Table of Contents <!-- omit in toc -->
1313

@@ -18,6 +18,7 @@ This is an optional feature. Supported features:
1818
- [Viewing the metrics](#viewing-the-metrics)
1919
- [Metric configuration](#metric-configuration)
2020
- [InfoContributor](#infocontributor)
21+
- [GRPC Health](#grpc-health)
2122
- [Opt-Out](#opt-out)
2223

2324
## Dependencies
@@ -178,6 +179,24 @@ You can view the grpc info along with your other info at `/actuator/info` (requi
178179
179180
You can turn of the service listing (for both actuator and grpc) using `grpc.server.reflectionServiceEnabled=false`.
180181
182+
## GRPC Health
183+
184+
By default, the health endpoint will use the standard gRPC implementation for health, which does not integrate with Spring Boot Actuator.
185+
186+
The server provides an optional integration with Actuator health information using the [gRPC Health API](https://grpc.io/docs/guides/health-checking/).
187+
188+
This integration enables the server to respond to gRPC health checks based on the `HealthEndpoint` from Actuator, which is the same used for the web version.
189+
190+
To enable this integration, add the following properties to your application configuration:
191+
192+
````properties
193+
grpc.server.health-service-type=ACTUATOR
194+
````
195+
196+
The integration allows you to check the health status for the whole service or specific health indicators, where the `service` is the name of the healthindicator.
197+
`Watch` is not supported because actuator is pull-based and does not automatically tries to determine the status of the service to notify clients.
198+
199+
181200
## Opt-Out
182201

183202
You can opt out from the actuator autoconfiguration using the following annotation:

0 commit comments

Comments
 (0)