confluent local kafka topic consume¶

Important

The confluent local commands are intended for a single-node development environment and are not suitable for a production environment. The data that are produced are transient and are intended to be temporary. For production-ready workflows, see Confluent Platform.

Description¶

Consume messages from a Kafka topic. Configuration and command guide: https://docs.confluent.io/confluent-cli/current/cp-produce-consume.html.

Truncated message headers will be printed if they exist.

confluent local kafka topic consume <topic> [flags]

Tip

You must export the path as an environment variable for each terminal session, or set the path to your Confluent Platform installation in your shell profile. For example:

cat ~/.bash_profile
export CONFLUENT_HOME=<path-to-confluent>
export PATH="${CONFLUENT_HOME}/bin:$PATH"

Flags¶

    --group string         Consumer group ID.
-b, --from-beginning       Consume from beginning of the topic.
    --offset int           The offset from the beginning to consume from.
    --partition int32      The partition to consume from. (default -1)
    --print-key            Print key of the message.
    --timestamp            Print message timestamp in milliseconds.
    --delimiter string     The delimiter separating each key and value. (default "\t")
    --config strings       A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
    --config-file string   The path to the configuration file for the consumer client, in JSON or Avro format.

Global Flags¶

-h, --help            Show help for this command.
    --unsafe-trace    Equivalent to -vvvv, but also log HTTP requests and responses which might contain plaintext secrets.
-v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

Examples¶

Consume message from topic “test” from the beginning and with keys printed.

confluent local kafka topic consume test --from-beginning --print-key