diff --git a/README.adoc b/README.adoc index e41b454..d45e730 100644 --- a/README.adoc +++ b/README.adoc @@ -16,7 +16,7 @@ Add the following dependency to your `pom.xml` com.deviceinsight.kafka kafka-health-check - 1.1.0 + 2.0.0-SNAPSHOT .... @@ -30,9 +30,9 @@ An example for an `application.yaml` is: kafka: health: topic: health-checks - sendReceiveTimeoutMs: 2500 - pollTimeoutMs: 200 - subscriptionTimeoutMs: 5000 + sendReceiveTimeout: 2.5s + pollTimeout: 200ms + subscriptionTimeout: 5s .... The values shown are the defaults. @@ -78,9 +78,9 @@ Now if you call the actuator endpoint `actuator/health` you should see the follo |Property |Default |Description |kafka.health.topic |`health-checks` | Topic to subscribe to -|kafka.health.sendReceiveTimeoutMs |2500 | The maximum time, in milliseconds, to wait for sending and receiving the message -|kafka.health.pollTimeoutMs |200 | The time, in milliseconds, spent fetching the data from the topic -|kafka.health.subscriptionTimeoutMs |5000 | The maximum time, in milliseconds, to wait for subscribing to topic +|kafka.health.sendReceiveTimeout |2.5s | The maximum time, given as https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration[Duration], to wait for sending and receiving the message. +|kafka.health.pollTimeout |200ms | The time, given as https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration[Duration], spent fetching the data from the topic +|kafka.health.subscriptionTimeout |5s | The maximum time, given as https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration[Duration], to wait for subscribing to topic |=== diff --git a/changelog.adoc b/changelog.adoc index 5e09e2c..cb4dbfc 100644 --- a/changelog.adoc +++ b/changelog.adoc @@ -3,7 +3,8 @@ == Version 2.0.0 -* Changed properties to duration type +* Health check timeouts are configured in duration format. +If you changed the defaults, please adapt your configuration. == Version 1.1.0