Compare commits
No commits in common. "develop" and "feature/ISSUE-17" have entirely different histories.
develop
...
feature/IS
114
README.adoc
Normal file
114
README.adoc
Normal file
@ -0,0 +1,114 @@
|
||||
= Kafka Health Check
|
||||
|
||||
:uri-build-status: https://travis-ci.org/deviceinsight/kafka-health-check
|
||||
:img-build-status: https://api.travis-ci.org/deviceinsight/kafka-health-check.svg?branch=master
|
||||
|
||||
image:{img-build-status}[Build Status Badge,link={uri-build-status}]
|
||||
|
||||
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>1.2.0</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
|
||||
sendReceiveTimeout: 2.5s
|
||||
pollTimeout: 200ms
|
||||
subscriptionTimeout: 5s
|
||||
....
|
||||
|
||||
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, processingProperties.buildConsumerProperties(),
|
||||
processingProperties.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.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
|
||||
|
||||
|===
|
||||
|
||||
== Releasing
|
||||
|
||||
Creating a new release involves the following steps:
|
||||
|
||||
. `./mvnw gitflow:release-start gitflow:release-finish`
|
||||
. `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`.
|
||||
105
README.md
105
README.md
@ -1,105 +0,0 @@
|
||||
# Kafka Health Check
|
||||
|
||||
> **Note.** _forked from [deviceinsight/kafka-health-check](https://github.com/deviceinsight/kafka-health-check) due to long period of inactivity_
|
||||
|
||||
This library provides a kafka health check for spring boot actuator.
|
||||
|
||||
## Usage
|
||||
|
||||
Add the following dependency to your `pom.xml`
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>me.bvn13.kafka.health</groupId>
|
||||
<artifactId>kafka-health-check</artifactId>
|
||||
<version>1.5.5</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
In the same maven module you can configure the topic, poll timeouts and the reception timeouts
|
||||
in the `application.yaml`
|
||||
|
||||
An example for an `application.yaml` is:
|
||||
|
||||
```yaml
|
||||
kafka:
|
||||
health:
|
||||
topic: health-checks
|
||||
sendReceiveTimeout: 2.5s
|
||||
pollTimeout: 200ms
|
||||
```
|
||||
|
||||
The values shown are the defaults.
|
||||
|
||||
IMPORTANT: Make sure the configured health check topic exists!
|
||||
|
||||
```java
|
||||
@Bean
|
||||
@ConfigurationProperties("kafka.health")
|
||||
public KafkaHealthProperties kafkaHealthProperties() {
|
||||
return new KafkaHealthProperties();
|
||||
}
|
||||
```
|
||||
|
||||
```java
|
||||
@Bean
|
||||
public KafkaConsumingHealthIndicator kafkaConsumingHealthIndicator(KafkaHealthProperties kafkaProperties,
|
||||
KafkaProperties processingProperties) {
|
||||
return new KafkaConsumingHealthIndicator(kafkaHealthProperties, processingProperties.buildConsumerProperties(),
|
||||
processingProperties.buildProducerProperties());
|
||||
}
|
||||
```
|
||||
|
||||
Now if you call the actuator endpoint `actuator/health` you should see the following output:
|
||||
|
||||
```json
|
||||
{
|
||||
"status" : "UP",
|
||||
"details" : {
|
||||
"kafkaConsuming" : {
|
||||
"status" : "UP"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
| 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. |
|
||||
|
||||
|
||||
|
||||
## Releasing
|
||||
|
||||
Creating a new release involves the following steps:
|
||||
|
||||
1. `./mvnw gitflow:release-start gitflow:release-finish`
|
||||
2. `git push origin master`
|
||||
3. `git push --tags`
|
||||
4. `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`:
|
||||
|
||||
```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`.
|
||||
22
changelog.adoc
Normal file
22
changelog.adoc
Normal file
@ -0,0 +1,22 @@
|
||||
= KafkaHealthCheck
|
||||
:icons: font
|
||||
|
||||
== Version 1.3.0
|
||||
|
||||
* Health check timeouts can now be configured in `java.time.Duration` format. The timeouts can still be configured using
|
||||
millisecond values (`long`) as well to stay compatible with old configurations.
|
||||
* Dependency versions are now managed by `spring-boot-dependencies`.
|
||||
(https://github.com/deviceinsight/kafka-health-check/issues/17[ISSUE-17])
|
||||
|
||||
== Version 1.2.0
|
||||
|
||||
* Reduce logging level of health check calls to `TRACE`.
|
||||
|
||||
== Version 1.1.0
|
||||
|
||||
* Make consumer groups unique by appending a random UUID when no group ID is configured explicitly.
|
||||
* Refactor health check strategy: Kafka polled continuously.
|
||||
|
||||
== Version 1.0.0
|
||||
|
||||
* Develop kafka health check
|
||||
36
changelog.md
36
changelog.md
@ -1,36 +0,0 @@
|
||||
# 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
|
||||
|
||||
## Version 1.3.0
|
||||
|
||||
* Health check timeouts can now be configured in `java.time.Duration` format. The timeouts can still be configured using
|
||||
millisecond values (`long`) as well to stay compatible with old configurations.
|
||||
* Dependency versions are now managed by `spring-boot-dependencies`. [ISSUE-17](https://github.com/deviceinsight/kafka-health-check/issues/17)
|
||||
* As of now, cache metrics can be exposed. For this purpose, a corresponding MeterRegistry instance must be passed
|
||||
when instantiating the Kafka Health Check. [ISSUE-20](https://github.com/deviceinsight/kafka-health-check/issues/20)
|
||||
* The cache size can now be configured via the property `kafka.health.cache.maximum-size`. The default value for the cache size is 200. [ISSUE-22](https://github.com/deviceinsight/kafka-health-check/issues/22)
|
||||
* Filtering messages that do not come from the same instance. [ISSUE-24](https://github.com/deviceinsight/kafka-health-check/issues/24)
|
||||
|
||||
## Version 1.2.0
|
||||
|
||||
* Reduce logging level of health check calls to `TRACE`.
|
||||
|
||||
## Version 1.1.0
|
||||
|
||||
* Make consumer groups unique by appending a random UUID when no group ID is configured explicitly.
|
||||
* Refactor health check strategy: Kafka polled continuously.
|
||||
|
||||
## Version 1.0.0
|
||||
|
||||
* Develop kafka health check
|
||||
61
pom.xml
61
pom.xml
@ -4,19 +4,19 @@
|
||||
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<groupId>me.bvn13.kafka.health</groupId>
|
||||
<groupId>com.deviceinsight.kafka</groupId>
|
||||
<artifactId>kafka-health-check</artifactId>
|
||||
<version>1.5.6-SNAPSHOT</version>
|
||||
<version>1.3.0-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>Kafka Health Check</name>
|
||||
<description>A kafka health check for spring boot actuator</description>
|
||||
<url>https://github.com/bvn13/kafka-health-check</url>
|
||||
<url>https://github.com/deviceinsight/kafka-health-check</url>
|
||||
|
||||
<parent>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-dependencies</artifactId>
|
||||
<version>2.7.1</version>
|
||||
<version>2.3.8.RELEASE</version>
|
||||
<relativePath />
|
||||
</parent>
|
||||
|
||||
@ -30,12 +30,11 @@
|
||||
<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>
|
||||
<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
|
||||
<nexus-staging-maven-plugin.version>1.6.13</nexus-staging-maven-plugin.version>
|
||||
<guava.version>30.1-jre</guava.version>
|
||||
|
||||
<nexus-staging-maven-plugin.version>1.6.8</nexus-staging-maven-plugin.version>
|
||||
<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
|
||||
<gitflow-maven-plugin.version>1.18.0</gitflow-maven-plugin.version>
|
||||
<gitflow-maven-plugin.version>1.15.1</gitflow-maven-plugin.version>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
@ -114,8 +113,7 @@
|
||||
<gitFlowConfig>
|
||||
<developmentBranch>develop</developmentBranch>
|
||||
</gitFlowConfig>
|
||||
<incrementVersionAtFinish>true</incrementVersionAtFinish>
|
||||
<versionDigitToIncrement>2</versionDigitToIncrement>
|
||||
<versionDigitToIncrement>1</versionDigitToIncrement>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
@ -136,15 +134,7 @@
|
||||
|
||||
<developers>
|
||||
<developer>
|
||||
<id>bvn13</id>
|
||||
<name>Vyacheslav Boyko</name>
|
||||
<email>dev@bvn13.me</email>
|
||||
<roles>
|
||||
<role>Developer</role>
|
||||
</roles>
|
||||
</developer>
|
||||
<developer>
|
||||
<id>ezienecker</id>
|
||||
<id>ManuZiD</id>
|
||||
<name>Emanuel Zienecker</name>
|
||||
<email>emanuel.zienecker@device-insight.com</email>
|
||||
<roles>
|
||||
@ -162,10 +152,10 @@
|
||||
</developers>
|
||||
|
||||
<scm>
|
||||
<connection>scm:git:git://github.com/bvn13/kafka-health-check.git</connection>
|
||||
<developerConnection>scm:git:ssh://git@github.com:bvn13/kafka-health-check.git</developerConnection>
|
||||
<connection>scm:git:git://github.com/deviceinsight/kafka-health-check.git</connection>
|
||||
<developerConnection>scm:git:ssh://git@github.com:deviceinsight/kafka-health-check.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
<url>https://github.com/bvn13/kafka-health-check.git</url>
|
||||
<url>https://github.com/deviceinsight/kafka-health-check.git</url>
|
||||
</scm>
|
||||
|
||||
<profiles>
|
||||
@ -198,31 +188,14 @@
|
||||
</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>${nexus.url}</nexusUrl>
|
||||
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
|
||||
<autoReleaseAfterClose>true</autoReleaseAfterClose>
|
||||
</configuration>
|
||||
</plugin>
|
||||
@ -246,12 +219,8 @@
|
||||
<distributionManagement>
|
||||
<snapshotRepository>
|
||||
<id>ossrh</id>
|
||||
<url>${nexus.url}/content/repositories/snapshots</url>
|
||||
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
|
||||
</snapshotRepository>
|
||||
<repository>
|
||||
<id>ossrh</id>
|
||||
<url>${nexus.url}/service/local/staging/deploy/maven2/</url>
|
||||
</repository>
|
||||
</distributionManagement>
|
||||
|
||||
<pluginRepositories>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
package me.bvn13.kafka.health;
|
||||
package com.deviceinsight.kafka.health;
|
||||
|
||||
final class KafkaCommunicationResult {
|
||||
|
||||
@ -1,12 +1,9 @@
|
||||
package me.bvn13.kafka.health;
|
||||
package com.deviceinsight.kafka.health;
|
||||
|
||||
import static java.util.concurrent.TimeUnit.MILLISECONDS;
|
||||
|
||||
import com.github.benmanes.caffeine.cache.Cache;
|
||||
import com.github.benmanes.caffeine.cache.Caffeine;
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.Tag;
|
||||
import io.micrometer.core.instrument.binder.cache.CaffeineCacheMetrics;
|
||||
import org.apache.kafka.clients.consumer.Consumer;
|
||||
import org.apache.kafka.clients.consumer.ConsumerConfig;
|
||||
import org.apache.kafka.clients.consumer.ConsumerRebalanceListener;
|
||||
@ -32,13 +29,13 @@ import java.util.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
import java.util.concurrent.CountDownLatch;
|
||||
import java.util.concurrent.ExecutionException;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
import java.util.concurrent.RejectedExecutionException;
|
||||
import java.util.concurrent.TimeoutException;
|
||||
import java.util.concurrent.atomic.AtomicBoolean;
|
||||
import java.util.stream.StreamSupport;
|
||||
|
||||
import javax.annotation.PostConstruct;
|
||||
import javax.annotation.PreDestroy;
|
||||
@ -47,40 +44,34 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(KafkaConsumingHealthIndicator.class);
|
||||
private static final String CONSUMER_GROUP_PREFIX = "health-check-";
|
||||
private static final String CACHE_NAME = "kafka-health-check";
|
||||
|
||||
private final Consumer<String, String> consumer;
|
||||
|
||||
private final Producer<String, String> producer;
|
||||
|
||||
private final String topic;
|
||||
private final Duration sendReceiveTimeout;
|
||||
private final Duration pollTimeout;
|
||||
private final Duration subscriptionTimeout;
|
||||
|
||||
private final ExecutorService executor;
|
||||
private final AtomicBoolean running;
|
||||
private final Cache<String, String> cache;
|
||||
private final String consumerGroupId;
|
||||
|
||||
private KafkaCommunicationResult kafkaCommunicationResult;
|
||||
|
||||
public KafkaConsumingHealthIndicator(KafkaHealthProperties kafkaHealthProperties,
|
||||
Map<String, Object> kafkaConsumerProperties, Map<String, Object> kafkaProducerProperties) {
|
||||
this(kafkaHealthProperties, kafkaConsumerProperties, kafkaProducerProperties, null);
|
||||
}
|
||||
|
||||
public KafkaConsumingHealthIndicator(KafkaHealthProperties kafkaHealthProperties,
|
||||
Map<String, Object> kafkaConsumerProperties, Map<String, Object> kafkaProducerProperties,
|
||||
MeterRegistry meterRegistry) {
|
||||
|
||||
logger.info("Initializing kafka health check with properties: {}", kafkaHealthProperties);
|
||||
this.topic = kafkaHealthProperties.getTopic();
|
||||
this.sendReceiveTimeout = kafkaHealthProperties.getSendReceiveTimeout();
|
||||
this.pollTimeout = kafkaHealthProperties.getPollTimeout();
|
||||
this.subscriptionTimeout = kafkaHealthProperties.getSubscriptionTimeout();
|
||||
|
||||
Map<String, Object> kafkaConsumerPropertiesCopy = new HashMap<>(kafkaConsumerProperties);
|
||||
|
||||
this.consumerGroupId = getUniqueConsumerGroupId(kafkaConsumerPropertiesCopy);
|
||||
kafkaConsumerPropertiesCopy.put(ConsumerConfig.GROUP_ID_CONFIG, consumerGroupId);
|
||||
setConsumerGroup(kafkaConsumerPropertiesCopy);
|
||||
|
||||
StringDeserializer deserializer = new StringDeserializer();
|
||||
StringSerializer serializer = new StringSerializer();
|
||||
@ -90,12 +81,8 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
this.executor = Executors.newSingleThreadExecutor();
|
||||
this.running = new AtomicBoolean(true);
|
||||
this.cache = Caffeine.newBuilder()
|
||||
.expireAfterWrite(sendReceiveTimeout)
|
||||
.maximumSize(kafkaHealthProperties.getCache().getMaximumSize())
|
||||
.build();
|
||||
|
||||
enableCacheMetrics(cache, meterRegistry);
|
||||
this.cache =
|
||||
Caffeine.newBuilder().expireAfterWrite(sendReceiveTimeout).build();
|
||||
|
||||
this.kafkaCommunicationResult =
|
||||
KafkaCommunicationResult.failure(new RejectedExecutionException("Kafka Health Check is starting."));
|
||||
@ -106,15 +93,14 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
subscribeToTopic();
|
||||
|
||||
if (kafkaCommunicationResult.isFailure()) {
|
||||
throw new BeanInitializationException("Kafka health check failed", kafkaCommunicationResult.getException());
|
||||
throw new BeanInitializationException("Kafka health check failed",
|
||||
kafkaCommunicationResult.getException());
|
||||
}
|
||||
|
||||
executor.submit(() -> {
|
||||
while (running.get()) {
|
||||
ConsumerRecords<String, String> records = consumer.poll(pollTimeout);
|
||||
StreamSupport.stream(records.spliterator(), false)
|
||||
.filter(record -> record.key() != null && record.key().contains(consumerGroupId))
|
||||
.forEach(record -> cache.put(record.key(), record.value()));
|
||||
records.forEach(record -> cache.put(record.key(), record.value()));
|
||||
}
|
||||
});
|
||||
}
|
||||
@ -127,11 +113,12 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
consumer.close();
|
||||
}
|
||||
|
||||
private String getUniqueConsumerGroupId(Map<String, Object> kafkaConsumerProperties) {
|
||||
private void setConsumerGroup(Map<String, Object> kafkaConsumerProperties) {
|
||||
try {
|
||||
String groupId = (String) kafkaConsumerProperties.getOrDefault(ConsumerConfig.GROUP_ID_CONFIG,
|
||||
UUID.randomUUID().toString());
|
||||
return CONSUMER_GROUP_PREFIX + groupId + "-" + InetAddress.getLocalHost().getHostAddress();
|
||||
kafkaConsumerProperties.put(ConsumerConfig.GROUP_ID_CONFIG,
|
||||
CONSUMER_GROUP_PREFIX + groupId + "-" + InetAddress.getLocalHost().getHostAddress());
|
||||
} catch (UnknownHostException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
@ -139,7 +126,7 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
private void subscribeToTopic() throws InterruptedException {
|
||||
|
||||
final AtomicBoolean subscribed = new AtomicBoolean(false);
|
||||
final CountDownLatch subscribed = new CountDownLatch(1);
|
||||
|
||||
logger.info("Subscribe to health check topic={}", topic);
|
||||
|
||||
@ -147,7 +134,7 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
@Override
|
||||
public void onPartitionsRevoked(Collection<TopicPartition> partitions) {
|
||||
// nothing to do here
|
||||
// nothing to do her
|
||||
}
|
||||
|
||||
@Override
|
||||
@ -155,13 +142,13 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
logger.debug("Got partitions = {}", partitions);
|
||||
|
||||
if (!partitions.isEmpty()) {
|
||||
subscribed.set(true);
|
||||
subscribed.countDown();
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
consumer.poll(pollTimeout);
|
||||
if (!subscribed.get()) {
|
||||
if (!subscribed.await(subscriptionTimeout.toMillis(), MILLISECONDS)) {
|
||||
throw new BeanInitializationException("Subscription to kafka failed, topic=" + topic);
|
||||
}
|
||||
|
||||
@ -188,12 +175,10 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
private String sendKafkaMessage() throws InterruptedException, ExecutionException, TimeoutException {
|
||||
|
||||
String message = UUID.randomUUID().toString();
|
||||
String key = createKeyFromMessageAndConsumerGroupId(message);
|
||||
|
||||
logger.trace("Send health check message = {}", message);
|
||||
|
||||
producer.send(new ProducerRecord<>(topic, key, message))
|
||||
.get(sendReceiveTimeout.toMillis(), MILLISECONDS);
|
||||
producer.send(new ProducerRecord<>(topic, message, message)).get(sendReceiveTimeout.toMillis(), MILLISECONDS);
|
||||
|
||||
return message;
|
||||
}
|
||||
@ -208,8 +193,7 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
long startTime = System.currentTimeMillis();
|
||||
while (true) {
|
||||
String key = createKeyFromMessageAndConsumerGroupId(expectedMessage);
|
||||
String receivedMessage = cache.getIfPresent(key);
|
||||
String receivedMessage = cache.getIfPresent(expectedMessage);
|
||||
if (expectedMessage.equals(receivedMessage)) {
|
||||
|
||||
builder.up();
|
||||
@ -219,7 +203,8 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
if (kafkaCommunicationResult.isFailure()) {
|
||||
goDown(builder);
|
||||
} else {
|
||||
builder.down(new TimeoutException("Sending and receiving took longer than " + sendReceiveTimeout))
|
||||
builder.down(new TimeoutException(
|
||||
"Sending and receiving took longer than " + sendReceiveTimeout ))
|
||||
.withDetail("topic", topic);
|
||||
}
|
||||
|
||||
@ -231,17 +216,4 @@ public class KafkaConsumingHealthIndicator extends AbstractHealthIndicator {
|
||||
private void goDown(Health.Builder builder) {
|
||||
builder.down(kafkaCommunicationResult.getException()).withDetail("topic", topic);
|
||||
}
|
||||
|
||||
private void enableCacheMetrics(Cache<String, String> cache, MeterRegistry meterRegistry) {
|
||||
if (meterRegistry == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
CaffeineCacheMetrics.monitor(meterRegistry, cache, CACHE_NAME,
|
||||
Collections.singletonList(Tag.of("instance", consumerGroupId)));
|
||||
}
|
||||
|
||||
private String createKeyFromMessageAndConsumerGroupId(String message) {
|
||||
return message + "-" + consumerGroupId;
|
||||
}
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
package me.bvn13.kafka.health;
|
||||
package com.deviceinsight.kafka.health;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
@ -7,7 +7,7 @@ public class KafkaHealthProperties {
|
||||
private String topic = "health-checks";
|
||||
private Duration sendReceiveTimeout = Duration.ofMillis(2500);
|
||||
private Duration pollTimeout = Duration.ofMillis(200);
|
||||
private KafkaHealthCheckCacheProperties cache = new KafkaHealthCheckCacheProperties();
|
||||
private Duration subscriptionTimeout = Duration.ofSeconds(5);
|
||||
|
||||
public String getTopic() {
|
||||
return topic;
|
||||
@ -43,18 +43,22 @@ public class KafkaHealthProperties {
|
||||
setPollTimeout(Duration.ofMillis(pollTimeoutMs));
|
||||
}
|
||||
|
||||
public KafkaHealthCheckCacheProperties getCache() {
|
||||
return cache;
|
||||
public Duration getSubscriptionTimeout() {
|
||||
return subscriptionTimeout;
|
||||
}
|
||||
|
||||
public void setCache(KafkaHealthCheckCacheProperties cache) {
|
||||
this.cache = cache;
|
||||
public void setSubscriptionTimeout(Duration subscriptionTimeout) {
|
||||
this.subscriptionTimeout = subscriptionTimeout;
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
public void setSubscriptionTimeoutMs(long subscriptionTimeoutMs) {
|
||||
setSubscriptionTimeout(Duration.ofMillis(subscriptionTimeoutMs));
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "KafkaHealthProperties{" + "topic='" + topic + '\'' + ", sendReceiveTimeout=" + sendReceiveTimeout +
|
||||
", pollTimeout=" + pollTimeout + ", cacheProperties=" +
|
||||
cache + '}';
|
||||
return "KafkaHealthProperties{topic='" + topic + "', sendReceiveTimeout=" + sendReceiveTimeout +
|
||||
", pollTimeout=" + pollTimeout + ", subscriptionTimeout=" + subscriptionTimeout + '}';
|
||||
}
|
||||
}
|
||||
@ -1,32 +0,0 @@
|
||||
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());
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
package me.bvn13.kafka.health;
|
||||
|
||||
public class KafkaHealthCheckCacheProperties {
|
||||
|
||||
private int maximumSize = 200;
|
||||
|
||||
public int getMaximumSize() {
|
||||
return maximumSize;
|
||||
}
|
||||
|
||||
public void setMaximumSize(int maximumSize) {
|
||||
this.maximumSize = maximumSize;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "CacheProperties{maximumSize=" + maximumSize + '}';
|
||||
}
|
||||
}
|
||||
@ -1 +0,0 @@
|
||||
org.springframework.boot.autoconfigure.EnableAutoConfiguration=me.bvn13.kafka.health.KafkaHealthAutoConfiguration
|
||||
@ -1,6 +1,6 @@
|
||||
package me.bvn13.kafka.health;
|
||||
package com.deviceinsight.kafka.health;
|
||||
|
||||
import static me.bvn13.kafka.health.KafkaConsumingHealthIndicatorTest.TOPIC;
|
||||
import static com.deviceinsight.kafka.health.KafkaConsumingHealthIndicatorTest.TOPIC;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
import kafka.server.KafkaServer;
|
||||
@ -1,4 +1,4 @@
|
||||
package me.bvn13.kafka.health;
|
||||
package com.deviceinsight.kafka.health;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.junit.jupiter.params.provider.Arguments.arguments;
|
||||
@ -21,20 +21,19 @@ public class KafkaHealthPropertiesTest {
|
||||
"kafka.health.topic", "custom-topic",
|
||||
"kafka.health.send-receive-timeout", "1m",
|
||||
"kafka.health.poll-timeout", "2s",
|
||||
"kafka.health.cache.maximum-size", "42"
|
||||
"kafka.health.subscription-timeout", "10s"
|
||||
));
|
||||
|
||||
private static final ConfigurationPropertySource MILLISECONDS_PROPERTY_SOURCE = new MapConfigurationPropertySource(ImmutableMap.of(
|
||||
"kafka.health.topic", "custom-topic",
|
||||
"kafka.health.send-receive-timeout-ms", "60000",
|
||||
"kafka.health.poll-timeout-ms", "2000",
|
||||
"kafka.health.cache.maximum-size", "42"
|
||||
"kafka.health.subscription-timeout-ms", "10000"
|
||||
));
|
||||
// @formatter:on
|
||||
|
||||
@ParameterizedTest(name = "using {0} based setters")
|
||||
@MethodSource("configurationPropertySources")
|
||||
@SuppressWarnings("unused")
|
||||
public void test_that_properties_bind_to_KafkaHealthProperties(String sourceName,
|
||||
ConfigurationPropertySource propertySource) {
|
||||
|
||||
@ -44,7 +43,7 @@ public class KafkaHealthPropertiesTest {
|
||||
assertThat(kafkaHealthProperties.getTopic()).isEqualTo("custom-topic");
|
||||
assertThat(kafkaHealthProperties.getSendReceiveTimeout()).isEqualTo(Duration.ofMinutes(1));
|
||||
assertThat(kafkaHealthProperties.getPollTimeout()).isEqualTo(Duration.ofSeconds(2));
|
||||
assertThat(kafkaHealthProperties.getCache().getMaximumSize()).isEqualTo(42);
|
||||
assertThat(kafkaHealthProperties.getSubscriptionTimeout()).isEqualTo(Duration.ofSeconds(10));
|
||||
}
|
||||
|
||||
static Stream<Arguments> configurationPropertySources() {
|
||||
Loading…
Reference in New Issue
Block a user