Skip to content

Commit 8ce5b13

Browse files
authored
Merge pull request #606 from yidongnan/docs/client-health
Mention grpcChannel health indicator in docs
2 parents 725d1d6 + 8fd6aff commit 8ce5b13

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/en/client/configuration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,13 @@ you have to define it via spring context (unless you wish to use `static`).
328328
> **Note:** `NameResolverProvider`s are registered gloablly, so might run into issues if you boot up two or more
329329
> applications simulataneosly in the same JVM (e.g. during tests).
330330
331+
## HealthIndicator
332+
333+
This library automatically provides a `grpcChannel` `HealthIndicator` (actuator/health) for all clients (shared).
334+
It will report the service as `OUT_OF_SERVICE` if any client has the `TRANSIENT_FAILURE` status.
335+
If you wish to exclude it and provide more specific `HealthIndicator`s,
336+
you can disable it by excluding the `GrpcClientHealthAutoConfiguration`
337+
331338
## Additional Topics <!-- omit in toc -->
332339

333340
- [Getting Started](getting-started.md)

0 commit comments

Comments
 (0)