From f61d673abe57ba437d84d65837db6726f4328b0c Mon Sep 17 00:00:00 2001 From: antoine Date: Sat, 2 Mar 2024 10:40:48 -0600 Subject: [PATCH] update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 916ceb6..494fcda 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Spring Boot Async Health Indicator -Async Health Indicator for [spring-boot-actuator](https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html) >=2.2.0 gives [Health Indicator](https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/actuate/health/HealthIndicator.html) the ability to get refreshed asynchronously on a background ThreadPoolExecutor using the annotation `@AsyncHealth`. +Async Health Indicator for [spring-boot-actuator](https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html) >=2.2 and >=3.0 gives [Health Indicator](https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/actuate/health/HealthIndicator.html) the ability to get refreshed asynchronously on a background ThreadPoolExecutor using the annotation `@AsyncHealth`. ##### When annotating a `HealthIndicator` with `@AsyncHealth`: @@ -28,6 +28,9 @@ The following details are added to the pre-existing `Health` details: This module is auto-configured. - Include dependency from maven central: + +For spring boot 2: + ``` com.teketik @@ -35,6 +38,16 @@ This module is auto-configured. boot2-v1.2 ``` +For spring boot 3: + +``` + + com.teketik + async-health-indicator + boot3-v1.3 + +``` + - Annotate any `HealthIndicator` with `@AsyncHealth(refreshRate = $REFRESH_RATE, timeout = $TIMEOUT, interruptOnTimeout = $INTERRUPT_ON_TIMEOUT)` `$REFRESH_RATE` = Fixed delay in seconds between the termination of the `health()` execution and the commencement of the next (default `1`).