org.apache.kafka.tools

Class VerifiableConsumer

java.lang.Object

org.apache.kafka.tools.VerifiableConsumer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.kafka.clients.consumer.ConsumerRebalanceListener, org.apache.kafka.clients.consumer.OffsetCommitCallback

public class VerifiableConsumer
extends java.lang.Object
implements java.io.Closeable, org.apache.kafka.clients.consumer.OffsetCommitCallback, org.apache.kafka.clients.consumer.ConsumerRebalanceListener

Command line consumer designed for system testing. It outputs consumer events to STDOUT as JSON formatted objects. The "name" field in each JSON event identifies the event type. The following events are currently supported:

• partitions_revoked: outputs the partitions revoked through ConsumerRebalanceListener.onPartitionsRevoked(Collection). See VerifiableConsumer.PartitionsRevoked
• partitions_assigned: outputs the partitions assigned through ConsumerRebalanceListener.onPartitionsAssigned(Collection) See VerifiableConsumer.PartitionsAssigned.
• records_consumed: contains a summary of records consumed in a single call to KafkaConsumer.poll(long). See VerifiableConsumer.RecordsConsumed.
• record_data: contains the key, value, and offset of an individual consumed record (only included if verbose output is enabled). See VerifiableConsumer.RecordData.
• offsets_committed: The result of every offset commit (only included if auto-commit is not enabled). See VerifiableConsumer.OffsetsCommitted
• shutdown_complete: emitted after the consumer returns from KafkaConsumer.close(). See VerifiableConsumer.ShutdownComplete.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerifiableConsumer.RecordData
static class	VerifiableConsumer.RecordsConsumed

Constructor Summary

Constructors

Constructor and Description
VerifiableConsumer(org.apache.kafka.clients.consumer.KafkaConsumer<java.lang.String,java.lang.String> consumer, java.io.PrintStream out, java.lang.String topic, int maxMessages, boolean useAutoCommit, boolean useAsyncCommit, boolean verbose)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	commitSync(java.util.Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets)
static VerifiableConsumer	createFromArgs(net.sourceforge.argparse4j.inf.ArgumentParser parser, java.lang.String[] args)
static void	main(java.lang.String[] args)
void	onComplete(java.util.Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets, java.lang.Exception exception)
void	onPartitionsAssigned(java.util.Collection<org.apache.kafka.common.TopicPartition> partitions)
void	onPartitionsRevoked(java.util.Collection<org.apache.kafka.common.TopicPartition> partitions)
void	run()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VerifiableConsumer

public VerifiableConsumer(org.apache.kafka.clients.consumer.KafkaConsumer<java.lang.String,java.lang.String> consumer,
                  java.io.PrintStream out,
                  java.lang.String topic,
                  int maxMessages,
                  boolean useAutoCommit,
                  boolean useAsyncCommit,
                  boolean verbose)

Method Detail

onComplete

public void onComplete(java.util.Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets,
              java.lang.Exception exception)

Specified by:

onComplete in interface org.apache.kafka.clients.consumer.OffsetCommitCallback

onPartitionsAssigned

public void onPartitionsAssigned(java.util.Collection<org.apache.kafka.common.TopicPartition> partitions)

Specified by:

onPartitionsAssigned in interface org.apache.kafka.clients.consumer.ConsumerRebalanceListener

onPartitionsRevoked

public void onPartitionsRevoked(java.util.Collection<org.apache.kafka.common.TopicPartition> partitions)

Specified by:

onPartitionsRevoked in interface org.apache.kafka.clients.consumer.ConsumerRebalanceListener

commitSync

public void commitSync(java.util.Map<org.apache.kafka.common.TopicPartition,org.apache.kafka.clients.consumer.OffsetAndMetadata> offsets)

run

public void run()

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

createFromArgs

public static VerifiableConsumer createFromArgs(net.sourceforge.argparse4j.inf.ArgumentParser parser,
                                java.lang.String[] args)
                                         throws net.sourceforge.argparse4j.inf.ArgumentParserException

Throws:

net.sourceforge.argparse4j.inf.ArgumentParserException

main

public static void main(java.lang.String[] args)