Skip to content

KAFKA-20684 [3/N]: Migrate tools to RebalanceListener #23104

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

Open
adikou wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open

KAFKA-20684 [3/N]: Migrate tools to RebalanceListener #23104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aeaedee
KAFKA-20684 [3/N]: Migrate tools to RebalanceListener
adikou Aug 6, 2026
d22ea67
Merge trunk into akousik/KAFKA-20684-tools
adikou Aug 6, 2026
91c9c06
Merge trunk into akousik/KAFKA-20684-tools
adikou Aug 7, 2026
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
14 changes: 8 additions & 6 deletions tools/src/main/java/org/apache/kafka/tools/ConsumerPerformance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@

import org.apache.kafka.clients.consumer.Consumer;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRebalanceListener;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.consumer.RebalanceConsumer;
import org.apache.kafka.clients.consumer.RebalanceListener;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.serialization.ByteArrayDeserializer;
import org.apache.kafka.common.utils.Utils;
Expand Down Expand Up @@ -140,10 +141,11 @@ private static void consume(Consumer<byte[], byte[]> consumer,
SimpleDateFormat dateFormat = options.dateFormat();

ConsumerPerfRebListener listener = new ConsumerPerfRebListener(joinTimeMs, joinStartMs, joinTimeMsInSingleRound);
consumer.setRebalanceListener(listener);
if (options.topic().isPresent()) {
consumer.subscribe(options.topic().get(), listener);
consumer.subscribe(options.topic().get());
} else {
consumer.subscribe(options.include().get(), listener);
consumer.subscribe(options.include().get());
}

// now start the benchmark
Expand Down Expand Up @@ -228,7 +230,7 @@ private static void printExtendedProgress(long bytesRead,
fetchTimeMs, intervalMbPerSec, intervalRecordsPerSec);
}

public static class ConsumerPerfRebListener implements ConsumerRebalanceListener {
public static class ConsumerPerfRebListener implements RebalanceListener {
private final AtomicLong joinTimeMs;
private final AtomicLong joinTimeMsInSingleRound;
private final Collection<TopicPartition> assignedPartitions;
Expand All @@ -242,15 +244,15 @@ public ConsumerPerfRebListener(AtomicLong joinTimeMs, long joinStartMs, AtomicLo
}

@Override
public void onPartitionsRevoked(Collection<TopicPartition> partitions) {
public void onPartitionsRevoked(Collection<TopicPartition> partitions, RebalanceConsumer consumer) {
assignedPartitions.removeAll(partitions);
if (assignedPartitions.isEmpty()) {
joinStartMs = System.currentTimeMillis();
}
}

@Override
public void onPartitionsAssigned(Collection<TopicPartition> partitions) {
public void onPartitionsAssigned(Collection<TopicPartition> partitions, RebalanceConsumer consumer) {
if (assignedPartitions.isEmpty()) {
long elapsedMs = System.currentTimeMillis() - joinStartMs;
joinTimeMs.addAndGet(elapsedMs);
Expand Down
10 changes: 6 additions & 4 deletions tools/src/main/java/org/apache/kafka/tools/TransactionalMessageCopier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@

import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerGroupMetadata;
import org.apache.kafka.clients.consumer.ConsumerRebalanceListener;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.consumer.OffsetAndMetadata;
import org.apache.kafka.clients.consumer.RebalanceConsumer;
import org.apache.kafka.clients.consumer.RebalanceListener;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
Expand Down Expand Up @@ -319,13 +320,13 @@ public static void runEventLoop(Namespace parsedArgs) {
final AtomicLong numMessagesProcessedSinceLastRebalance = new AtomicLong(0);
final AtomicLong totalMessageProcessed = new AtomicLong(0);
if (groupMode) {
consumer.subscribe(Set.of(topicName), new ConsumerRebalanceListener() {
consumer.setRebalanceListener(new RebalanceListener() {
@Override
public void onPartitionsRevoked(Collection<TopicPartition> partitions) {
public void onPartitionsRevoked(Collection<TopicPartition> partitions, RebalanceConsumer rebalanceConsumer) {
}

@Override
public void onPartitionsAssigned(Collection<TopicPartition> partitions) {
public void onPartitionsAssigned(Collection<TopicPartition> partitions, RebalanceConsumer rebalanceConsumer) {
remainingMessages.set(partitions.stream()
.mapToLong(partition -> messagesRemaining(consumer, partition)).sum());
numMessagesProcessedSinceLastRebalance.set(0);
Expand All @@ -339,6 +340,7 @@ public void onPartitionsAssigned(Collection<TopicPartition> partitions) {
));
}
});
consumer.subscribe(Set.of(topicName));
} else {
TopicPartition inputPartition = new TopicPartition(topicName, parsedArgs.getInt("inputPartition"));
consumer.assign(Set.of(inputPartition));
Expand Down
18 changes: 11 additions & 7 deletions tools/src/main/java/org/apache/kafka/tools/VerifiableConsumer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@

import org.apache.kafka.clients.consumer.CloseOptions;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRebalanceListener;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.GroupProtocol;
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.consumer.OffsetAndMetadata;
import org.apache.kafka.clients.consumer.OffsetCommitCallback;
import org.apache.kafka.clients.consumer.RangeAssignor;
import org.apache.kafka.clients.consumer.RebalanceConsumer;
import org.apache.kafka.clients.consumer.RebalanceListener;
import org.apache.kafka.clients.consumer.RoundRobinAssignor;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.errors.FencedInstanceIdException;
Expand Down Expand Up @@ -75,9 +76,11 @@
* events are currently supported:
*
* <ul>
* <li>partitions_revoked: outputs the partitions revoked through {@link ConsumerRebalanceListener#onPartitionsRevoked(Collection)}.
* <li>partitions_revoked: outputs the partitions revoked through
* {@link RebalanceListener#onPartitionsRevoked(Collection, RebalanceConsumer)}.
* See {@link org.apache.kafka.tools.VerifiableConsumer.PartitionsRevoked}.</li>
* <li>partitions_assigned: outputs the partitions assigned through {@link ConsumerRebalanceListener#onPartitionsAssigned(Collection)}
* <li>partitions_assigned: outputs the partitions assigned through
* {@link RebalanceListener#onPartitionsAssigned(Collection, RebalanceConsumer)}
* See {@link org.apache.kafka.tools.VerifiableConsumer.PartitionsAssigned}.</li>
* <li>records_consumed: contains a summary of records consumed in a single call to {@link KafkaConsumer#poll(Duration)}.
* See {@link org.apache.kafka.tools.VerifiableConsumer.RecordsConsumed}.</li>
Expand All @@ -91,7 +94,7 @@
* See {@link org.apache.kafka.tools.VerifiableConsumer.ShutdownComplete}.</li>
* </ul>
*/
public class VerifiableConsumer implements Closeable, OffsetCommitCallback, ConsumerRebalanceListener {
public class VerifiableConsumer implements Closeable, OffsetCommitCallback, RebalanceListener {

private static final Logger log = LoggerFactory.getLogger(VerifiableConsumer.class);

Expand Down Expand Up @@ -201,12 +204,12 @@ public void onComplete(Map<TopicPartition, OffsetAndMetadata> offsets, Exception
}

@Override
public void onPartitionsAssigned(Collection<TopicPartition> partitions) {
public void onPartitionsAssigned(Collection<TopicPartition> partitions, RebalanceConsumer rebalanceConsumer) {
printJson(new PartitionsAssigned(partitions));
}

@Override
public void onPartitionsRevoked(Collection<TopicPartition> partitions) {
public void onPartitionsRevoked(Collection<TopicPartition> partitions, RebalanceConsumer rebalanceConsumer) {
printJson(new PartitionsRevoked(partitions));
}

Expand Down Expand Up @@ -236,7 +239,8 @@ public void commitSync(Map<TopicPartition, OffsetAndMetadata> offsets) {
public void run() {
try {
printJson(new StartupComplete());
consumer.subscribe(List.of(topic), this);
consumer.setRebalanceListener(this);
consumer.subscribe(List.of(topic));

while (!isFinished()) {
ConsumerRecords<String, String> records = consumer.poll(Duration.ofMillis(Long.MAX_VALUE));
Expand Down
16 changes: 8 additions & 8 deletions tools/src/test/java/org/apache/kafka/tools/ConsumerPerformanceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,13 +314,13 @@ public void testConsumerListenerWithAllPartitionRevokedAndAssigned() throws Inte
AtomicLong joinTimeMs = new AtomicLong(0);
AtomicLong joinTimeMsInSingleRound = new AtomicLong(0);
ConsumerPerformance.ConsumerPerfRebListener listener = new ConsumerPerformance.ConsumerPerfRebListener(joinTimeMs, 0, joinTimeMsInSingleRound);
listener.onPartitionsAssigned(Set.of(tp0));
listener.onPartitionsAssigned(Set.of(tp0), null);
long lastJoinTimeMs = joinTimeMs.get();

// All assigned partitions have been revoked.
listener.onPartitionsRevoked(Set.of(tp0));
listener.onPartitionsRevoked(Set.of(tp0), null);
Thread.sleep(100);
listener.onPartitionsAssigned(Set.of(tp1));
listener.onPartitionsAssigned(Set.of(tp1), null);

assertNotEquals(lastJoinTimeMs, joinTimeMs.get());
}
Expand All @@ -333,13 +333,13 @@ public void testConsumerListenerWithPartialPartitionRevokedAndAssigned() throws
AtomicLong joinTimeMs = new AtomicLong(0);
AtomicLong joinTimeMsInSingleRound = new AtomicLong(0);
ConsumerPerformance.ConsumerPerfRebListener listener = new ConsumerPerformance.ConsumerPerfRebListener(joinTimeMs, 0, joinTimeMsInSingleRound);
listener.onPartitionsAssigned(Set.of(tp0, tp1));
listener.onPartitionsAssigned(Set.of(tp0, tp1), null);
long lastJoinTimeMs = joinTimeMs.get();

// The assigned partitions were partially revoked.
listener.onPartitionsRevoked(Set.of(tp0));
listener.onPartitionsRevoked(Set.of(tp0), null);
Thread.sleep(100);
listener.onPartitionsAssigned(Set.of(tp0));
listener.onPartitionsAssigned(Set.of(tp0), null);

assertEquals(lastJoinTimeMs, joinTimeMs.get());
}
Expand All @@ -352,11 +352,11 @@ public void testConsumerListenerWithoutPartitionRevoked() throws InterruptedExce
AtomicLong joinTimeMs = new AtomicLong(0);
AtomicLong joinTimeMsInSingleRound = new AtomicLong(0);
ConsumerPerformance.ConsumerPerfRebListener listener = new ConsumerPerformance.ConsumerPerfRebListener(joinTimeMs, 0, joinTimeMsInSingleRound);
listener.onPartitionsAssigned(Set.of(tp0));
listener.onPartitionsAssigned(Set.of(tp0), null);
long lastJoinTimeMs = joinTimeMs.get();

Thread.sleep(100);
listener.onPartitionsAssigned(Set.of(tp1));
listener.onPartitionsAssigned(Set.of(tp1), null);

assertEquals(lastJoinTimeMs, joinTimeMs.get());
}
Expand Down
Loading