Last active
March 5, 2021 22:26
-
-
Save gmyrianthous/5a04a8dd330e23d524414f801fe3671c to your computer and use it in GitHub Desktop.
kafka-console-consumer-help
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
$ kafka/bin/kafka-console-consumer.sh | |
Option Description | |
------ ----------- | |
--blacklist <String: blacklist> Blacklist of topics to exclude from | |
consumption. | |
--bootstrap-server <String: server to REQUIRED (unless old consumer is | |
connect to> used): The server to connect to. | |
--consumer-property <String: A mechanism to pass user-defined | |
consumer_prop> properties in the form key=value to | |
the consumer. | |
--consumer.config <String: config file> Consumer config properties file. Note | |
that [consumer-property] takes | |
precedence over this config. | |
--csv-reporter-enabled If set, the CSV metrics reporter will | |
be enabled | |
--delete-consumer-offsets If specified, the consumer path in | |
zookeeper is deleted when starting up | |
--enable-systest-events Log lifecycle events of the consumer | |
in addition to logging consumed | |
messages. (This is specific for | |
system tests.) | |
--formatter <String: class> The name of a class to use for | |
formatting kafka messages for | |
display. (default: kafka.tools. | |
DefaultMessageFormatter) | |
--from-beginning If the consumer does not already have | |
an established offset to consume | |
from, start with the earliest | |
message present in the log rather | |
than the latest message. | |
--group <String: consumer group id> The consumer group id of the consumer. | |
--isolation-level <String> Set to read_committed in order to | |
filter out transactional messages | |
which are not committed. Set to | |
read_uncommittedto read all | |
messages. (default: read_uncommitted) | |
--key-deserializer <String: | |
deserializer for key> | |
--max-messages <Integer: num_messages> The maximum number of messages to | |
consume before exiting. If not set, | |
consumption is continual. | |
--metrics-dir <String: metrics If csv-reporter-enable is set, and | |
directory> this parameter isset, the csv | |
metrics will be output here | |
--new-consumer Use the new consumer implementation. | |
This is the default, so this option | |
is deprecated and will be removed in | |
a future release. | |
--offset <String: consume offset> The offset id to consume from (a non- | |
negative number), or 'earliest' | |
which means from beginning, or | |
'latest' which means from end | |
(default: latest) | |
--partition <Integer: partition> The partition to consume from. | |
Consumption starts from the end of | |
the partition unless '--offset' is | |
specified. | |
--property <String: prop> The properties to initialize the | |
message formatter. | |
--skip-message-on-error If there is an error when processing a | |
message, skip it instead of halt. | |
--timeout-ms <Integer: timeout_ms> If specified, exit if no message is | |
available for consumption for the | |
specified interval. | |
--topic <String: topic> The topic id to consume on. | |
--value-deserializer <String: | |
deserializer for values> | |
--whitelist <String: whitelist> Whitelist of topics to include for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment