Update for next development version

Tag release

README.md

@@ -12,7 +12,7 @@ Add the following dependency to your `pom.xml`
 <dependency>
     <groupId>me.bvn13.kafka.health</groupId>
     <artifactId>kafka-health-check</artifactId>
-    <version>1.4.0</version>
+    <version>1.5.5</version>
 </dependency>
 ```
 
@@ -66,12 +66,13 @@ Now if you call the actuator endpoint `actuator/health` you should see the follo
 ## Configuration
 
 
-| Property                           | Default          | Description                                                                                                                                                                                                                                                |
-|------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| kafka.health.topic                 | `health-checks`  | Topic to subscribe to                                                                                                                                                                                                                                      |
-| kafka.health.sendReceiveTimeout    | 2.5s             | The maximum time, given as [Duration](https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration), to wait for sending and receiving the message. |
-| kafka.health.pollTimeout           | 200ms            | The time, given as [Duration](https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration), spent fetching the data from the topic                           |
-| kafka.health.cache.maximumSize     | 200              | Specifies the maximum number of entries the cache may contain.                                                                                                                                                                                             |
+| Property                        | Default         | Description                                                                                                                                                                                                                                     |
+|---------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| kafka.health.enabled            | false           | Enabling kafka health check                                                                                                                                                                                                                     |
+| kafka.health.topic              | `health-checks` | Topic to subscribe to                                                                                                                                                                                                                           |
+| kafka.health.sendReceiveTimeout | 2.5s            | The maximum time, given as [Duration](https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration), to wait for sending and receiving the message.|
+| kafka.health.pollTimeout        | 200ms           | The time, given as [Duration](https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-conversion-duration), spent fetching the data from the topic                |
+| kafka.health.cache.maximumSize  | 200             | Specifies the maximum number of entries the cache may contain.                                                                                                                                                                                  |
 
 
 

changelog.md

@@ -1,9 +1,16 @@
 # KafkaHealthCheck
 
+## Version 1.5.3
+
+* Added SpringBootAutoConfiguration
+
+## Version 1.5.2
+
+* Changed maven group publication: switched into `me.bvn13.kafka.health`
+
 ## Version 1.4.0
 
 * Got rid of `subscriptionTimeout` as a redundant timeout
-* Changed maven group publication: switched into `me.bvn13.kafka.health`
 
 ## Version 1.3.0
 

pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>me.bvn13.kafka.health</groupId>
 	<artifactId>kafka-health-check</artifactId>
-	<version>1.4.2</version>
+	<version>1.5.6-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<name>Kafka Health Check</name>
@@ -30,11 +30,12 @@
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
 		<!-- Versions -->
+		<nexus.url>https://s01.oss.sonatype.org</nexus.url>
 		<guava.version>30.1.1-jre</guava.version>
-
-		<nexus-staging-maven-plugin.version>1.6.8</nexus-staging-maven-plugin.version>
+		<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
+		<nexus-staging-maven-plugin.version>1.6.13</nexus-staging-maven-plugin.version>
 		<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
-		<gitflow-maven-plugin.version>1.15.1</gitflow-maven-plugin.version>
+		<gitflow-maven-plugin.version>1.18.0</gitflow-maven-plugin.version>
 	</properties>
 
 	<dependencies>
@@ -113,7 +114,8 @@
 						<gitFlowConfig>
 							<developmentBranch>develop</developmentBranch>
 						</gitFlowConfig>
-						<versionDigitToIncrement>1</versionDigitToIncrement>
+						<incrementVersionAtFinish>true</incrementVersionAtFinish>
+						<versionDigitToIncrement>2</versionDigitToIncrement>
 					</configuration>
 				</plugin>
 			</plugins>
@@ -196,14 +198,31 @@
 							</execution>
 						</executions>
 					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-deploy-plugin</artifactId>
+						<version>${maven-deploy-plugin.version}</version>
+						<configuration>
+							<skip>true</skip>
+						</configuration>
+					</plugin>
 					<plugin>
 						<groupId>org.sonatype.plugins</groupId>
 						<artifactId>nexus-staging-maven-plugin</artifactId>
 						<version>${nexus-staging-maven-plugin.version}</version>
 						<extensions>true</extensions>
+						<executions>
+							<execution>
+								<id>default-deploy</id>
+								<phase>deploy</phase>
+								<goals>
+									<goal>deploy</goal>
+								</goals>
+							</execution>
+						</executions>
 						<configuration>
 							<serverId>ossrh</serverId>
-							<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
+							<nexusUrl>${nexus.url}</nexusUrl>
 							<autoReleaseAfterClose>true</autoReleaseAfterClose>
 						</configuration>
 					</plugin>
@@ -227,8 +246,12 @@
 			<distributionManagement>
 				<snapshotRepository>
 					<id>ossrh</id>
-					<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
+					<url>${nexus.url}/content/repositories/snapshots</url>
 				</snapshotRepository>
+				<repository>
+					<id>ossrh</id>
+					<url>${nexus.url}/service/local/staging/deploy/maven2/</url>
+				</repository>
 			</distributionManagement>
 
 			<pluginRepositories>

src/main/java/me/bvn13/kafka/health/KafkaHealthAutoConfiguration.java

@@ -0,0 +1,32 @@
+package me.bvn13.kafka.health;
+
+import org.springframework.boot.actuate.health.AbstractHealthIndicator;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.kafka.KafkaProperties;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ConditionalOnClass(AbstractHealthIndicator.class)
+@ConditionalOnProperty(name = "kafka.health.enabled", havingValue = "true")
+public class KafkaHealthAutoConfiguration {
+
+	@Bean
+	@ConditionalOnMissingBean(KafkaHealthProperties.class)
+	@ConfigurationProperties("kafka.health")
+	public KafkaHealthProperties kafkaHealthProperties() {
+		return new KafkaHealthProperties();
+	}
+
+	@Bean
+	@ConditionalOnMissingBean(KafkaConsumingHealthIndicator.class)
+	public KafkaConsumingHealthIndicator kafkaConsumingHealthIndicator(KafkaHealthProperties kafkaHealthProperties,
+			KafkaProperties kafkaProperties) {
+		return new KafkaConsumingHealthIndicator(kafkaHealthProperties, kafkaProperties.buildConsumerProperties(),
+				kafkaProperties.buildProducerProperties());
+	}
+
+}

src/main/resources/META-INF/spring.factories

@@ -0,0 +1 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=me.bvn13.kafka.health.KafkaHealthAutoConfiguration