Compare commits

...

18 Commits

Author SHA1 Message Date
bvn13 167360566a Update for next development version 2022-06-30 12:07:02 +03:00
bvn13 8701dcbc0f Merge tag '1.5.5' into develop
Tag release
2022-06-30 12:06:59 +03:00
bvn13 f701f1c27d Merge branch 'release/1.5.5' 2022-06-30 12:06:58 +03:00
bvn13 7385f3a4cd Update versions for release 2022-06-30 12:06:33 +03:00
bvn13 0bcfa5ddb0 added feature toggling for enabling/disabling 2022-06-30 12:06:07 +03:00
bvn13 9ee98e5446 Update for next development version 2022-06-30 11:36:10 +03:00
bvn13 bb51848708 Merge branch 'release/1.5.4' 2022-06-30 11:36:05 +03:00
bvn13 58b33cb8d9 Merge tag '1.5.4' into develop
Tag release
2022-06-30 11:36:05 +03:00
bvn13 ec804bb9f8 Update versions for release 2022-06-30 11:35:39 +03:00
bvn13 432f8627c9 added feature toggling for enabling/disabling 2022-06-30 11:35:28 +03:00
bvn13 18b3754075 updated changelog 2022-06-28 22:27:19 +03:00
bvn13 7478766182 Update for next development version 2022-06-28 21:46:09 +03:00
bvn13 bf394419cf Merge branch 'release/1.5.3' 2022-06-28 21:46:04 +03:00
bvn13 6156326222 Merge tag '1.5.3' into develop
Tag release
2022-06-28 21:46:04 +03:00
bvn13 cc56c30401 Update versions for release 2022-06-28 21:45:48 +03:00
bvn13 1cb2c91dba #11 - added SpringBootAutoConfiguration 2022-06-28 21:45:19 +03:00
bvn13 96c9a2d891 Update for next development version 2022-06-28 17:38:54 +03:00
bvn13 56722ca245 Merge tag '1.5.2' into develop
Tag release
2022-06-28 17:38:52 +03:00
5 changed files with 51 additions and 10 deletions

View File

@ -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.5.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. |

View File

@ -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

View File

@ -6,7 +6,7 @@
<groupId>me.bvn13.kafka.health</groupId>
<artifactId>kafka-health-check</artifactId>
<version>1.5.2</version>
<version>1.5.6-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Kafka Health Check</name>
@ -114,7 +114,7 @@
<gitFlowConfig>
<developmentBranch>develop</developmentBranch>
</gitFlowConfig>
<incrementVersionAtFinish>false</incrementVersionAtFinish>
<incrementVersionAtFinish>true</incrementVersionAtFinish>
<versionDigitToIncrement>2</versionDigitToIncrement>
</configuration>
</plugin>

View File

@ -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());
}
}

View File

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