You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/actuator.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This page focuses on the integration with
7
7
This is an optional feature. Supported features:
8
8
9
9
- Client + server metrics
10
-
- Server `InfoContributor`
10
+
- Server `InfoContributor` and `GRPC Health API`
11
11
12
12
## Table of Contents <!-- omit in toc -->
13
13
@@ -18,6 +18,7 @@ This is an optional feature. Supported features:
18
18
-[Viewing the metrics](#viewing-the-metrics)
19
19
-[Metric configuration](#metric-configuration)
20
20
-[InfoContributor](#infocontributor)
21
+
-[GRPC Health](#grpc-health)
21
22
-[Opt-Out](#opt-out)
22
23
23
24
## Dependencies
@@ -178,6 +179,24 @@ You can view the grpc info along with your other info at `/actuator/info` (requi
178
179
179
180
You can turn of the service listing (for both actuator and grpc) using `grpc.server.reflectionServiceEnabled=false`.
180
181
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
+
181
200
## Opt-Out
182
201
183
202
You can opt out from the actuator autoconfiguration using the following annotation:
0 commit comments