bvn13/kafka-health-check
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adapted README and changelog

Browse Source
This commit is contained in:
Simon Flandergan 2019-10-11 21:01:08 +02:00
parent a2e8d783cd
commit e6af5cfe8f
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.adoc
View File

@ -16,7 +16,7 @@ Add the following dependency to your `pom.xml`
<dependency> <dependency>
<groupId>com.deviceinsight.kafka</groupId> <groupId>com.deviceinsight.kafka</groupId>
<artifactId>kafka-health-check</artifactId> <artifactId>kafka-health-check</artifactId>
<version>1.1.0</version> <version>2.0.0-SNAPSHOT</version>
</dependency> </dependency>
.... ....
@ -30,9 +30,9 @@ An example for an `application.yaml` is:
kafka: kafka:
health: health:
topic: health-checks topic: health-checks
sendReceiveTimeoutMs: 2500 sendReceiveTimeout: 2.5s
pollTimeoutMs: 200 pollTimeout: 200ms
subscriptionTimeoutMs: 5000 subscriptionTimeout: 5s
.... ....
The values shown are the defaults. 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 |Property |Default |Description
|kafka.health.topic |`health-checks` | Topic to subscribe to |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.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.pollTimeoutMs |200 | The time, in milliseconds, spent fetching the data from the topic |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.subscriptionTimeoutMs |5000 | The maximum time, in milliseconds, to wait for subscribing to 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
|=== |===

3
changelog.adoc
View File

@ -3,7 +3,8 @@
== Version 2.0.0 == 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 == Version 1.1.0