Skip to content

KAFKA-10357: Add setup method to internal topics #10317

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
guozhangwang merged 2 commits into from
Mar 18, 2021
Merged

KAFKA-10357: Add setup method to internal topics #10317

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6249853
KAFKA-10357: Add setup method to internal topics
cadonna Mar 12, 2021
7139413
Include feedback
cadonna Mar 17, 2021
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
158 changes: 127 additions & 31 deletions streams/src/main/java/org/apache/kafka/streams/processor/internals/InternalTopicManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
import org.slf4j.Logger;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
Expand Down Expand Up @@ -186,14 +188,23 @@ public ValidationResult validate(final Map<String, InternalTopicConfig> topicCon
);
}

maybeThrowTimeoutException(topicDescriptionsStillToValidate, topicConfigsStillToValidate, deadline);
maybeThrowTimeoutException(
Arrays.asList(topicDescriptionsStillToValidate, topicConfigsStillToValidate),
deadline,
String.format("Could not validate internal topics within %d milliseconds. " +
"This can happen if the Kafka cluster is temporarily not available.", retryTimeoutMs)
);

if (!descriptionsForTopic.isEmpty() || !configsForTopic.isEmpty()) {
Utils.sleep(100);
}
}

maybeSleep(topicDescriptionsStillToValidate, topicConfigsStillToValidate, deadline);
maybeSleep(
Arrays.asList(topicDescriptionsStillToValidate, topicConfigsStillToValidate),
deadline,
"validated"
);
}

log.info("Completed validation of internal topics {}.", topicConfigs.keySet());
Expand Down Expand Up @@ -242,35 +253,6 @@ private <V> void doValidateTopic(final ValidationResult validationResult,
}
}

private void maybeThrowTimeoutException(final Set<String> topicDescriptionsStillToValidate,
final Set<String> topicConfigsStillToValidate,
final long deadline) {
if (!topicDescriptionsStillToValidate.isEmpty() || !topicConfigsStillToValidate.isEmpty()) {
final long now = time.milliseconds();
if (now >= deadline) {
final String timeoutError = String.format("Could not validate internal topics within %d milliseconds. " +
"This can happen if the Kafka cluster is temporarily not available.", retryTimeoutMs);
log.error(timeoutError);
throw new TimeoutException(timeoutError);
}
}
}

private void maybeSleep(final Set<String> topicDescriptionsStillToValidate,
final Set<String> topicConfigsStillToValidate,
final long deadline) {
if (!topicDescriptionsStillToValidate.isEmpty() || !topicConfigsStillToValidate.isEmpty()) {
final long now = time.milliseconds();
log.info(
"Internal topics {} could not be validated. Will retry in {} milliseconds. Remaining time in milliseconds: {}",
new HashSet<>(topicDescriptionsStillToValidate).addAll(topicConfigsStillToValidate),
retryBackOffMs,
deadline - now
);
Utils.sleep(retryBackOffMs);
}
}

private void validatePartitionCount(final ValidationResult validationResult,
final InternalTopicConfig topicConfig,
final TopicDescription topicDescription) {
Expand Down Expand Up @@ -580,4 +562,118 @@ private Set<String> validateTopics(final Set<String> topicsToValidate,

return topicsToCreate;
}

/**
* Sets up internal topics.
*
* Either the given topic are all created or the method fails with an exception.
*
* @param topicConfigs internal topics to setup
*/
public void setup(final Map<String, InternalTopicConfig> topicConfigs) {

@rodesai rodesai Mar 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we make an effort to clean up created topics on failure? currently this method is not retriable

@cadonna cadonna Mar 17, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree that cleaning up would be a good idea.

log.info("Starting to setup internal topics {}.", topicConfigs.keySet());

final long now = time.milliseconds();
final long deadline = now + retryTimeoutMs;

final Map<String, Map<String, String>> newTopicConfigs = topicConfigs.values().stream()

@rodesai rodesai Mar 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

naming nit: topicConfigsWithRetention

@cadonna cadonna Mar 17, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not rename this since the additional retention is only added in case of topicConfig instanceof WindowedChangelogTopicConfig, which is one of three. What about streamsSideTopicConfigs to emphasize that these are the topic configs that Streams sets by default possibly overidden by user code in the Streams app.

.collect(Collectors.toMap(
InternalTopicConfig::name,
topicConfig -> topicConfig.getProperties(defaultTopicConfigs, windowChangeLogAdditionalRetention)
));
final Set<String> topicStillToCreate = new HashSet<>(topicConfigs.keySet());
while (!topicStillToCreate.isEmpty()) {
final Set<NewTopic> newTopics = topicStillToCreate.stream()
.map(topicName -> new NewTopic(
topicName,
topicConfigs.get(topicName).numberOfPartitions(),
Optional.of(replicationFactor)
).configs(newTopicConfigs.get(topicName))
).collect(Collectors.toSet());

log.info("Going to create internal topics: " + newTopics);
final CreateTopicsResult createTopicsResult = adminClient.createTopics(newTopics);

final Map<String, KafkaFuture<Void>> createResultForTopic = createTopicsResult.values();
while (!createResultForTopic.isEmpty()) {
for (final InternalTopicConfig topicConfig : topicConfigs.values()) {
final String topicName = topicConfig.name();
if (!createResultForTopic.containsKey(topicName)) {
throw new IllegalStateException("Create topic results do not contain internal topic " + topicName
+ " to setup. " + BUG_ERROR_MESSAGE);
}
final KafkaFuture<Void> createResult = createResultForTopic.get(topicName);
if (createResult.isDone()) {
try {
createResult.get();
topicStillToCreate.remove(topicName);
} catch (final ExecutionException executionException) {
final Throwable cause = executionException.getCause();
if (cause instanceof TopicExistsException) {
log.info("Internal topic {} already exists. Topic is probably marked for deletion. " +
"Will retry to create this topic later (to let broker complete async delete operation first)",
topicName);
} else if (cause instanceof TimeoutException) {
log.info("Creating internal topic {} timed out.", topicName);
} else {
log.error("Unexpected error during creation of internal topic: ", cause);
throw new StreamsException(
String.format("Could not create internal topic %s for the following reason: ", topicName),
cause
);
}
} catch (final InterruptedException interruptedException) {
throw new InterruptException(interruptedException);
} finally {
createResultForTopic.remove(topicName);
}
}
}

maybeThrowTimeoutException(
Collections.singletonList(topicStillToCreate),
deadline,
String.format("Could not create internal topics within %d milliseconds. This can happen if the " +

@rodesai rodesai Mar 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case I think we should include some error details here. In particular, the last seen error for each topic. I'm worried about cases where we try to create but the create times out but is eventually successful. We'd return an error back, but the user would have no way to know that setup failed because an internal topic already exists.

@cadonna cadonna Mar 17, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds like a really useful idea.

"Kafka cluster is temporarily not available or a topic is marked for deletion and the broker " +
"did not complete its deletion within the timeout.", retryTimeoutMs)
);

if (!topicStillToCreate.isEmpty()) {
Utils.sleep(100);
}
}

maybeSleep(Collections.singletonList(topicStillToCreate), deadline, "created");
}

log.info("Completed setup of internal topics {}.", topicConfigs.keySet());
}

private void maybeThrowTimeoutException(final List<Set<String>> resultSetsStillToProcess,
final long deadline,
final String errorMessage) {
if (resultSetsStillToProcess.stream().anyMatch(resultSet -> !resultSet.isEmpty())) {
final long now = time.milliseconds();
if (now >= deadline) {
log.error(errorMessage);
throw new TimeoutException(errorMessage);
}
}
}

private void maybeSleep(final List<Set<String>> resultSetsStillToValidate,
final long deadline,
final String action) {
if (resultSetsStillToValidate.stream().anyMatch(resultSet -> !resultSet.isEmpty())) {
final long now = time.milliseconds();
log.info(
"Internal topics {} could not be {}. Will retry in {} milliseconds. Remaining time in milliseconds: {}",
resultSetsStillToValidate.stream().flatMap(Collection::stream).collect(Collectors.toSet()),
action,
retryBackOffMs,
deadline - now
);
Utils.sleep(retryBackOffMs);
}
}
}
Loading