Skip to content

BE: Allow overriding producer and consumer properties #874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 8, 2025
Merged

BE: Allow overriding producer and consumer properties #874

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e522a85
BE: Allow overriding producer and consumer properties
wernerdv Feb 27, 2025
68e0efd
BE: Allow overriding producer and consumer properties
wernerdv Feb 28, 2025
604762c
Merge branch 'main' into issues/527
Haarolean Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api/src/main/java/io/kafbat/ui/config/ClustersProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ public static class Cluster {

MetricsConfigData metrics;
Map<String, Object> properties;
Map<String, Object> consumerProperties;
Map<String, Object> producerProperties;
boolean readOnly = false;

Long pollingThrottleRate;
Expand Down Expand Up @@ -189,6 +191,8 @@ private void setMetricsDefaults() {
private void flattenClusterProperties() {
for (Cluster cluster : clusters) {
cluster.setProperties(flattenClusterProperties(null, cluster.getProperties()));
cluster.setConsumerProperties(flattenClusterProperties(null, cluster.getConsumerProperties()));
cluster.setProducerProperties(flattenClusterProperties(null, cluster.getProducerProperties()));
}
}

Expand Down
2 changes: 2 additions & 0 deletions api/src/main/java/io/kafbat/ui/model/KafkaCluster.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ public class KafkaCluster {
private final String version;
private final String bootstrapServers;
private final Properties properties;
private final Properties consumerProperties;
private final Properties producerProperties;
private final boolean readOnly;
private final MetricsConfig metricsConfig;
private final DataMasking masking;
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/kafbat/ui/service/ConsumerGroupService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ public EnhancedConsumer createConsumer(KafkaCluster cluster,
Map<String, Object> properties) {
Properties props = new Properties();
KafkaClientSslPropertiesUtil.addKafkaSslProperties(cluster.getOriginalProperties().getSsl(), props);
props.putAll(cluster.getProperties());
props.putAll(cluster.getConsumerProperties());
props.put(ConsumerConfig.CLIENT_ID_CONFIG, "kafbat-ui-consumer-" + System.currentTimeMillis());
props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, cluster.getBootstrapServers());
props.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
Expand Down
2 changes: 2 additions & 0 deletions api/src/main/java/io/kafbat/ui/service/KafkaClusterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ public KafkaCluster create(ClustersProperties properties,
builder.name(clusterProperties.getName());
builder.bootstrapServers(clusterProperties.getBootstrapServers());
builder.properties(convertProperties(clusterProperties.getProperties()));
builder.consumerProperties(convertProperties(clusterProperties.getConsumerProperties()));
builder.producerProperties(convertProperties(clusterProperties.getProducerProperties()));
builder.readOnly(clusterProperties.isReadOnly());
builder.masking(DataMasking.create(clusterProperties.getMasking()));
builder.pollingSettings(PollingSettings.create(clusterProperties, properties));
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/kafbat/ui/service/MessagesService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ public static KafkaProducer<byte[], byte[]> createProducer(KafkaCluster cluster,
Map<String, Object> additionalProps) {
Properties properties = new Properties();
KafkaClientSslPropertiesUtil.addKafkaSslProperties(cluster.getOriginalProperties().getSsl(), properties);
properties.putAll(cluster.getProperties());
properties.putAll(cluster.getProducerProperties());
properties.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, cluster.getBootstrapServers());
properties.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, ByteArraySerializer.class);
properties.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, ByteArraySerializer.class);
Expand Down
7 changes: 7 additions & 0 deletions api/src/test/java/io/kafbat/ui/AbstractIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import org.apache.kafka.clients.admin.AdminClient;
import org.apache.kafka.clients.admin.AdminClientConfig;
import org.apache.kafka.clients.admin.NewTopic;
import org.apache.kafka.common.IsolationLevel;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.function.ThrowingConsumer;
import org.junit.jupiter.api.io.TempDir;
Expand Down Expand Up @@ -102,6 +103,12 @@ public void initialize(@NotNull ConfigurableApplicationContext context) {
System.setProperty("kafka.clusters.0.audit.topicAuditEnabled", "true");
System.setProperty("kafka.clusters.0.audit.consoleAuditEnabled", "true");

System.setProperty("kafka.clusters.0.consumerProperties.request.timeout.ms", "60000");
System.setProperty("kafka.clusters.0.consumerProperties.isolation.level",
IsolationLevel.READ_COMMITTED.toString());
System.setProperty("kafka.clusters.0.producerProperties.request.timeout.ms", "45000");
System.setProperty("kafka.clusters.0.producerProperties.max.block.ms", "80000");

System.setProperty("kafka.clusters.1.name", SECOND_LOCAL);
System.setProperty("kafka.clusters.1.readOnly", "true");
System.setProperty("kafka.clusters.1.bootstrapServers", kafka.getBootstrapServers());
Expand Down
21 changes: 21 additions & 0 deletions api/src/test/java/io/kafbat/ui/service/ConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.kafbat.ui.service;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;

import io.kafbat.ui.AbstractIntegrationTest;
import io.kafbat.ui.model.BrokerConfigDTO;
Expand All @@ -10,6 +11,10 @@
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.common.IsolationLevel;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
Expand Down Expand Up @@ -79,6 +84,22 @@ void testAlterReadonlyConfig() {
.expectStatus().isBadRequest();
}

@Test
void testKafkaClientCustomProperties() {
KafkaCluster cluster = applicationContext.getBean(ClustersStorage.class).getClusterByName(LOCAL).orElseThrow();

Properties consumerProps = cluster.getConsumerProperties();

assertEquals("60000", consumerProps.getProperty(ConsumerConfig.REQUEST_TIMEOUT_MS_CONFIG));
assertEquals(IsolationLevel.READ_COMMITTED.toString(),
consumerProps.getProperty(ConsumerConfig.ISOLATION_LEVEL_CONFIG));

Properties producerProps = cluster.getProducerProperties();

assertEquals("45000", producerProps.getProperty(ProducerConfig.REQUEST_TIMEOUT_MS_CONFIG));
assertEquals("80000", producerProps.getProperty(ProducerConfig.MAX_BLOCK_MS_CONFIG));
}

private Optional<BrokerConfigDTO> getConfig(String name) {
List<BrokerConfigDTO> configs = webTestClient.get()
.uri("/api/clusters/{clusterName}/brokers/{id}/configs", LOCAL, 1)
Expand Down
Loading