From d63d6fabacdc4dfd3370ec4e191206cc19d7c5a5 Mon Sep 17 00:00:00 2001
From: Emanuel Zienecker <emanuel.zienecker@device-insight.com>
Date: Fri, 29 Mar 2019 13:03:52 +0100
Subject: [PATCH] Complete readme and correct constructor from
 KafkaCommunicationResult

---
 README.adoc                                   | 112 +++++++++++++++++-
 .../health/KafkaCommunicationResult.java      |   6 +-
 2 files changed, 113 insertions(+), 5 deletions(-)

diff --git a/README.adoc b/README.adoc
index c6658d1..597d0a1 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,3 +1,111 @@
-= KafkaHealthCheck
+= Kafka Health Check
 
-Spring kafka health check.
+This library provides a kafka health check for spring boot actuator.
+
+== Usage
+
+Add the following dependency to your `pom.xml`
+
+[source,xml]
+....
+<dependency>
+    <groupId>com.deviceinsight.kafka</groupId>
+    <artifactId>kafka-health-check</artifactId>
+    <version>0.1.0-SNAPSHOT</version>
+</dependency>
+....
+
+In the same maven module you can configure the topic, poll timeouts, subscription timeouts and the receive timeouts
+in the `application.yml`
+
+An example for an `application.yaml` is:
+
+[source,yaml]
+....
+kafka:
+  health:
+    topic: health-checks
+    sendReceiveTimeoutMs: 2500
+    pollTimeoutMs: 200
+    subscriptionTimeoutMs: 5000
+....
+
+The values shown are the defaults.
+
+IMPORTANT: Make sure the configured health check topic exists!
+
+[source,java]
+....
+@Bean
+@ConfigurationProperties("kafka.health")
+public KafkaHealthProperties kafkaHealthProperties() {
+    return new KafkaHealthProperties();
+}
+....
+
+[source,java]
+....
+@Bean
+public KafkaConsumingHealthIndicator kafkaConsumingHealthIndicator(KafkaHealthProperties kafkaProperties,
+        KafkaProperties processingProperties) {
+    return new KafkaConsumingHealthIndicator(kafkaHealthProperties, kafkaProperties.buildConsumerProperties(),
+            kafkaProperties.buildProducerProperties());
+}
+....
+
+Now if you call the actuator endpoint `actuator/health` you should see the following output:
+
+[source,json]
+....
+{
+   "status" : "UP",
+   "details" : {
+      "kafkaConsuming" : {
+         "status" : "UP"
+      }
+   }
+}
+....
+
+== Configuration
+
+|===
+|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
+
+|===
+
+== Releasing
+
+Creating a new release involves the following steps:
+
+. `./mvnw -DenableSshAgent=true jgitflow:release-start jgitflow:release-finish` +
+[NOTE]
+The `-DenableSshAgent=true` is only necessary, if you cloned the repository via SSH.
+. `git push origin master`
+. `git push --tags`
+. `git push origin develop`
+
+In order to deploy the release to Maven Central, you need to create an account at https://issues.sonatype.org and
+configure your account in `~/.m2/settings.xml`:
+
+[source,xml]
+....
+<settings>
+  <servers>
+    <server>
+      <id>ossrh</id>
+      <username>your-jira-id</username>
+      <password>your-jira-pwd</password>
+    </server>
+  </servers>
+</settings>
+....
+
+The account also needs access to the project on Maven Central. This can be requested by another project member.
+
+Then check out the release you want to deploy (`git checkout x.y.z`) and run `./mvnw deploy -Prelease`.
diff --git a/src/main/java/com/deviceinsight/kafka/health/KafkaCommunicationResult.java b/src/main/java/com/deviceinsight/kafka/health/KafkaCommunicationResult.java
index aad4ae0..2996488 100644
--- a/src/main/java/com/deviceinsight/kafka/health/KafkaCommunicationResult.java
+++ b/src/main/java/com/deviceinsight/kafka/health/KafkaCommunicationResult.java
@@ -6,8 +6,8 @@ final class KafkaCommunicationResult {
 
 	private final Exception exception;
 
-	private KafkaCommunicationResult() {
-		this.topic = null;
+	private KafkaCommunicationResult(String topic) {
+		this.topic = topic;
 		this.exception = null;
 	}
 
@@ -17,7 +17,7 @@ final class KafkaCommunicationResult {
 	}
 
 	static KafkaCommunicationResult success(String topic) {
-		return new KafkaCommunicationResult();
+		return new KafkaCommunicationResult(topic);
 	}
 
 	static KafkaCommunicationResult failure(String topic, Exception exception) {