Skip to content

Commit aa7429e

Browse files
iliaxiliax
andauthored
BE: Update Kafka config-related info on schedule (#3764)
Co-authored-by: iliax <[email protected]>
1 parent 3ca417f commit aa7429e

File tree

3 files changed

+90
-82
lines changed

3 files changed

+90
-82
lines changed

kafka-ui-api/src/main/java/com/provectus/kafka/ui/service/FeatureService.java

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,13 @@
44
import com.provectus.kafka.ui.model.KafkaCluster;
55
import com.provectus.kafka.ui.service.ReactiveAdminClient.ClusterDescription;
66
import java.util.ArrayList;
7-
import java.util.Collection;
87
import java.util.List;
98
import java.util.Map;
109
import java.util.Optional;
1110
import java.util.Set;
1211
import java.util.function.Predicate;
13-
import javax.annotation.Nullable;
1412
import lombok.RequiredArgsConstructor;
1513
import lombok.extern.slf4j.Slf4j;
16-
import org.apache.kafka.common.Node;
1714
import org.apache.kafka.common.acl.AclOperation;
1815
import org.springframework.stereotype.Service;
1916
import reactor.core.publisher.Flux;
@@ -24,11 +21,10 @@
2421
@Slf4j
2522
public class FeatureService {
2623

27-
private static final String DELETE_TOPIC_ENABLED_SERVER_PROPERTY = "delete.topic.enable";
28-
2924
private final AdminClientService adminClientService;
3025

31-
public Mono<List<ClusterFeature>> getAvailableFeatures(KafkaCluster cluster,
26+
public Mono<List<ClusterFeature>> getAvailableFeatures(ReactiveAdminClient adminClient,
27+
KafkaCluster cluster,
3228
ClusterDescription clusterDescription) {
3329
List<Mono<ClusterFeature>> features = new ArrayList<>();
3430

@@ -46,29 +42,17 @@ public Mono<List<ClusterFeature>> getAvailableFeatures(KafkaCluster cluster,
4642
features.add(Mono.just(ClusterFeature.SCHEMA_REGISTRY));
4743
}
4844

49-
features.add(topicDeletionEnabled(cluster, clusterDescription.getController()));
45+
features.add(topicDeletionEnabled(adminClient));
5046
features.add(aclView(cluster));
5147
features.add(aclEdit(clusterDescription));
5248

5349
return Flux.fromIterable(features).flatMap(m -> m).collectList();
5450
}
5551

56-
private Mono<ClusterFeature> topicDeletionEnabled(KafkaCluster cluster, @Nullable Node controller) {
57-
if (controller == null) {
58-
return Mono.just(ClusterFeature.TOPIC_DELETION); // assuming it is enabled by default
59-
}
60-
return adminClientService.get(cluster)
61-
.flatMap(ac -> ac.loadBrokersConfig(List.of(controller.id())))
62-
.map(config ->
63-
config.values().stream()
64-
.flatMap(Collection::stream)
65-
.filter(e -> e.name().equals(DELETE_TOPIC_ENABLED_SERVER_PROPERTY))
66-
.map(e -> Boolean.parseBoolean(e.value()))
67-
.findFirst()
68-
.orElse(true))
69-
.flatMap(enabled -> enabled
70-
? Mono.just(ClusterFeature.TOPIC_DELETION)
71-
: Mono.empty());
52+
private Mono<ClusterFeature> topicDeletionEnabled(ReactiveAdminClient adminClient) {
53+
return adminClient.isTopicDeletionEnabled()
54+
? Mono.just(ClusterFeature.TOPIC_DELETION)
55+
: Mono.empty();
7256
}
7357

7458
private Mono<ClusterFeature> aclEdit(ClusterDescription clusterDescription) {

kafka-ui-api/src/main/java/com/provectus/kafka/ui/service/ReactiveAdminClient.java

Lines changed: 63 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@
3232
import java.util.stream.Stream;
3333
import javax.annotation.Nullable;
3434
import lombok.AccessLevel;
35+
import lombok.AllArgsConstructor;
36+
import lombok.Builder;
3537
import lombok.Getter;
36-
import lombok.RequiredArgsConstructor;
3738
import lombok.Value;
3839
import lombok.extern.slf4j.Slf4j;
3940
import org.apache.kafka.clients.admin.AdminClient;
@@ -75,7 +76,6 @@
7576
import org.apache.kafka.common.errors.UnknownTopicOrPartitionException;
7677
import org.apache.kafka.common.errors.UnsupportedVersionException;
7778
import org.apache.kafka.common.requests.DescribeLogDirsResponse;
78-
import org.apache.kafka.common.resource.ResourcePattern;
7979
import org.apache.kafka.common.resource.ResourcePatternFilter;
8080
import reactor.core.publisher.Flux;
8181
import reactor.core.publisher.Mono;
@@ -85,7 +85,7 @@
8585

8686

8787
@Slf4j
88-
@RequiredArgsConstructor
88+
@AllArgsConstructor
8989
public class ReactiveAdminClient implements Closeable {
9090

9191
public enum SupportedFeature {
@@ -104,7 +104,8 @@ public enum SupportedFeature {
104104
this.predicate = (admin, ver) -> Mono.just(ver != null && ver >= fromVersion);
105105
}
106106

107-
static Mono<Set<SupportedFeature>> forVersion(AdminClient ac, @Nullable Float kafkaVersion) {
107+
static Mono<Set<SupportedFeature>> forVersion(AdminClient ac, String kafkaVersionStr) {
108+
@Nullable Float kafkaVersion = KafkaVersion.parse(kafkaVersionStr).orElse(null);
108109
return Flux.fromArray(SupportedFeature.values())
109110
.flatMap(f -> f.predicate.apply(ac, kafkaVersion).map(enabled -> Tuples.of(f, enabled)))
110111
.filter(Tuple2::getT2)
@@ -123,19 +124,46 @@ public static class ClusterDescription {
123124
Set<AclOperation> authorizedOperations;
124125
}
125126

126-
public static Mono<ReactiveAdminClient> create(AdminClient adminClient) {
127-
return getClusterVersion(adminClient)
128-
.flatMap(ver ->
129-
getSupportedUpdateFeaturesForVersion(adminClient, ver)
130-
.map(features ->
131-
new ReactiveAdminClient(adminClient, ver, features)));
127+
@Builder
128+
private record ConfigRelatedInfo(String version,
129+
Set<SupportedFeature> features,
130+
boolean topicDeletionIsAllowed) {
131+
132+
private static Mono<ConfigRelatedInfo> extract(AdminClient ac, int controllerId) {
133+
return loadBrokersConfig(ac, List.of(controllerId))
134+
.map(map -> map.isEmpty() ? List.<ConfigEntry>of() : map.get(controllerId))
135+
.flatMap(configs -> {
136+
String version = "1.0-UNKNOWN";
137+
boolean topicDeletionEnabled = true;
138+
for (ConfigEntry entry : configs) {
139+
if (entry.name().contains("inter.broker.protocol.version")) {
140+
version = entry.value();
141+
}
142+
if (entry.name().equals("delete.topic.enable")) {
143+
topicDeletionEnabled = Boolean.parseBoolean(entry.value());
144+
}
145+
}
146+
var builder = ConfigRelatedInfo.builder()
147+
.version(version)
148+
.topicDeletionIsAllowed(topicDeletionEnabled);
149+
return SupportedFeature.forVersion(ac, version)
150+
.map(features -> builder.features(features).build());
151+
});
152+
}
132153
}
133154

134-
private static Mono<Set<SupportedFeature>> getSupportedUpdateFeaturesForVersion(AdminClient ac, String versionStr) {
135-
@Nullable Float kafkaVersion = KafkaVersion.parse(versionStr).orElse(null);
136-
return SupportedFeature.forVersion(ac, kafkaVersion);
155+
public static Mono<ReactiveAdminClient> create(AdminClient adminClient) {
156+
return describeClusterImpl(adminClient, Set.of())
157+
// choosing node from which we will get configs (starting with controller)
158+
.flatMap(descr -> descr.controller != null
159+
? Mono.just(descr.controller)
160+
: Mono.justOrEmpty(descr.nodes.stream().findFirst())
161+
)
162+
.flatMap(node -> ConfigRelatedInfo.extract(adminClient, node.id()))
163+
.map(info -> new ReactiveAdminClient(adminClient, info));
137164
}
138165

166+
139167
private static Mono<Boolean> isAuthorizedSecurityEnabled(AdminClient ac, @Nullable Float kafkaVersion) {
140168
return toMono(ac.describeAcls(AclBindingFilter.ANY).values())
141169
.thenReturn(true)
@@ -174,11 +202,10 @@ public static <T> Mono<T> toMono(KafkaFuture<T> future) {
174202

175203
@Getter(AccessLevel.PACKAGE) // visible for testing
176204
private final AdminClient client;
177-
private final String version;
178-
private final Set<SupportedFeature> features;
205+
private volatile ConfigRelatedInfo configRelatedInfo;
179206

180207
public Set<SupportedFeature> getClusterFeatures() {
181-
return features;
208+
return configRelatedInfo.features();
182209
}
183210

184211
public Mono<Set<String>> listTopics(boolean listInternal) {
@@ -190,7 +217,20 @@ public Mono<Void> deleteTopic(String topicName) {
190217
}
191218

192219
public String getVersion() {
193-
return version;
220+
return configRelatedInfo.version();
221+
}
222+
223+
public boolean isTopicDeletionEnabled() {
224+
return configRelatedInfo.topicDeletionIsAllowed();
225+
}
226+
227+
public Mono<Void> updateInternalStats(@Nullable Node controller) {
228+
if (controller == null) {
229+
return Mono.empty();
230+
}
231+
return ConfigRelatedInfo.extract(client, controller.id())
232+
.doOnNext(info -> this.configRelatedInfo = info)
233+
.then();
194234
}
195235

196236
public Mono<Map<String, List<ConfigEntry>>> getTopicsConfig() {
@@ -200,7 +240,7 @@ public Mono<Map<String, List<ConfigEntry>>> getTopicsConfig() {
200240
//NOTE: skips not-found topics (for which UnknownTopicOrPartitionException was thrown by AdminClient)
201241
//and topics for which DESCRIBE_CONFIGS permission is not set (TopicAuthorizationException was thrown)
202242
public Mono<Map<String, List<ConfigEntry>>> getTopicsConfig(Collection<String> topicNames, boolean includeDoc) {
203-
var includeDocFixed = features.contains(SupportedFeature.CONFIG_DOCUMENTATION_RETRIEVAL) && includeDoc;
243+
var includeDocFixed = includeDoc && getClusterFeatures().contains(SupportedFeature.CONFIG_DOCUMENTATION_RETRIEVAL);
204244
// we need to partition calls, because it can lead to AdminClient timeouts in case of large topics count
205245
return partitionCalls(
206246
topicNames,
@@ -349,7 +389,7 @@ public Mono<Map<Integer, Map<String, DescribeLogDirsResponse.LogDirInfo>>> descr
349389
}
350390

351391
public Mono<ClusterDescription> describeCluster() {
352-
return describeClusterImpl(client, features);
392+
return describeClusterImpl(client, getClusterFeatures());
353393
}
354394

355395
private static Mono<ClusterDescription> describeClusterImpl(AdminClient client, Set<SupportedFeature> features) {
@@ -371,23 +411,6 @@ private static Mono<ClusterDescription> describeClusterImpl(AdminClient client,
371411
);
372412
}
373413

374-
private static Mono<String> getClusterVersion(AdminClient client) {
375-
return describeClusterImpl(client, Set.of())
376-
// choosing node from which we will get configs (starting with controller)
377-
.flatMap(descr -> descr.controller != null
378-
? Mono.just(descr.controller)
379-
: Mono.justOrEmpty(descr.nodes.stream().findFirst())
380-
)
381-
.flatMap(node -> loadBrokersConfig(client, List.of(node.id())))
382-
.flatMap(configs -> configs.values().stream()
383-
.flatMap(Collection::stream)
384-
.filter(entry -> entry.name().contains("inter.broker.protocol.version"))
385-
.findFirst()
386-
.map(configEntry -> Mono.just(configEntry.value()))
387-
.orElse(Mono.empty()))
388-
.switchIfEmpty(Mono.just("1.0-UNKNOWN"));
389-
}
390-
391414
public Mono<Void> deleteConsumerGroups(Collection<String> groupIds) {
392415
return toMono(client.deleteConsumerGroups(groupIds).all())
393416
.onErrorResume(GroupIdNotFoundException.class,
@@ -421,7 +444,7 @@ public Mono<Void> createPartitions(Map<String, NewPartitions> newPartitionsMap)
421444
// NOTE: places whole current topic config with new one. Entries that were present in old config,
422445
// but missed in new will be set to default
423446
public Mono<Void> updateTopicConfig(String topicName, Map<String, String> configs) {
424-
if (features.contains(SupportedFeature.INCREMENTAL_ALTER_CONFIGS)) {
447+
if (getClusterFeatures().contains(SupportedFeature.INCREMENTAL_ALTER_CONFIGS)) {
425448
return getTopicsConfigImpl(List.of(topicName), false)
426449
.map(conf -> conf.getOrDefault(topicName, List.of()))
427450
.flatMap(currentConfigs -> incrementalAlterConfig(topicName, currentConfigs, configs));
@@ -596,17 +619,17 @@ Mono<Map<TopicPartition, Long>> listOffsetsUnsafe(Collection<TopicPartition> par
596619
}
597620

598621
public Mono<Collection<AclBinding>> listAcls(ResourcePatternFilter filter) {
599-
Preconditions.checkArgument(features.contains(SupportedFeature.AUTHORIZED_SECURITY_ENABLED));
622+
Preconditions.checkArgument(getClusterFeatures().contains(SupportedFeature.AUTHORIZED_SECURITY_ENABLED));
600623
return toMono(client.describeAcls(new AclBindingFilter(filter, AccessControlEntryFilter.ANY)).values());
601624
}
602625

603626
public Mono<Void> createAcls(Collection<AclBinding> aclBindings) {
604-
Preconditions.checkArgument(features.contains(SupportedFeature.AUTHORIZED_SECURITY_ENABLED));
627+
Preconditions.checkArgument(getClusterFeatures().contains(SupportedFeature.AUTHORIZED_SECURITY_ENABLED));
605628
return toMono(client.createAcls(aclBindings).all());
606629
}
607630

608631
public Mono<Void> deleteAcls(Collection<AclBinding> aclBindings) {
609-
Preconditions.checkArgument(features.contains(SupportedFeature.AUTHORIZED_SECURITY_ENABLED));
632+
Preconditions.checkArgument(getClusterFeatures().contains(SupportedFeature.AUTHORIZED_SECURITY_ENABLED));
610633
var filters = aclBindings.stream().map(AclBinding::toFilter).collect(Collectors.toSet());
611634
return toMono(client.deleteAcls(filters).all()).then();
612635
}

kafka-ui-api/src/main/java/com/provectus/kafka/ui/service/StatisticsService.java

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,25 +37,26 @@ public Mono<Statistics> updateCache(KafkaCluster c) {
3737
private Mono<Statistics> getStatistics(KafkaCluster cluster) {
3838
return adminClientService.get(cluster).flatMap(ac ->
3939
ac.describeCluster().flatMap(description ->
40-
Mono.zip(
41-
List.of(
42-
metricsCollector.getBrokerMetrics(cluster, description.getNodes()),
43-
getLogDirInfo(description, ac),
44-
featureService.getAvailableFeatures(cluster, description),
45-
loadTopicConfigs(cluster),
46-
describeTopics(cluster)),
47-
results ->
48-
Statistics.builder()
49-
.status(ServerStatusDTO.ONLINE)
50-
.clusterDescription(description)
51-
.version(ac.getVersion())
52-
.metrics((Metrics) results[0])
53-
.logDirInfo((InternalLogDirStats) results[1])
54-
.features((List<ClusterFeature>) results[2])
55-
.topicConfigs((Map<String, List<ConfigEntry>>) results[3])
56-
.topicDescriptions((Map<String, TopicDescription>) results[4])
57-
.build()
58-
)))
40+
ac.updateInternalStats(description.getController()).then(
41+
Mono.zip(
42+
List.of(
43+
metricsCollector.getBrokerMetrics(cluster, description.getNodes()),
44+
getLogDirInfo(description, ac),
45+
featureService.getAvailableFeatures(ac, cluster, description),
46+
loadTopicConfigs(cluster),
47+
describeTopics(cluster)),
48+
results ->
49+
Statistics.builder()
50+
.status(ServerStatusDTO.ONLINE)
51+
.clusterDescription(description)
52+
.version(ac.getVersion())
53+
.metrics((Metrics) results[0])
54+
.logDirInfo((InternalLogDirStats) results[1])
55+
.features((List<ClusterFeature>) results[2])
56+
.topicConfigs((Map<String, List<ConfigEntry>>) results[3])
57+
.topicDescriptions((Map<String, TopicDescription>) results[4])
58+
.build()
59+
))))
5960
.doOnError(e ->
6061
log.error("Failed to collect cluster {} info", cluster.getName(), e))
6162
.onErrorResume(

0 commit comments

Comments
 (0)