Ultimate Kafka Commands Cheat Sheet for Efficient Management
Kafka Commands Cheat Sheet: Simplifying Kafka Management
Apache Kafka has become a cornerstone for real-time data processing, handling massive streams of data with efficiency and reliability. Managing Kafka clusters and topics requires familiarity with its command-line tools. Here’s a comprehensive cheat sheet to help you navigate Kafka commands effectively.
Kafka Basics
-
Start Kafka Server:
bin/kafka-server-start.sh config/server.properties
This command starts the Kafka broker using the specified configuration file (
config/server.properties
). -
Create a Topic:
bin/kafka-topics.sh --create --topic
--bootstrap-server localhost:9092 --partitions 3 --replication-factor 2 Creates a new topic with the specified name, number of partitions (
--partitions
), and replication factor (--replication-factor
). -
List Topics:
bin/kafka-topics.sh --list --bootstrap-server localhost:9092
Lists all existing topics in the Kafka cluster connected to
localhost:9092
.
Managing Topics
-
Describe a Topic:
bin/kafka-topics.sh --describe --topic
--bootstrap-server localhost:9092 Provides detailed information about the specified topic, including its partitions, replicas, and configuration.
-
Delete a Topic:
bin/kafka-topics.sh --delete --topic
--bootstrap-server localhost:9092 Deletes the specified topic from the Kafka cluster.
Producing and Consuming Messages
-
Produce Messages:
bin/kafka-console-producer.sh --topic
--bootstrap-server localhost:9092 Starts a console producer that allows you to manually send messages to the specified topic.
-
Consume Messages:
bin/kafka-console-consumer.sh --topic
--bootstrap-server localhost:9092 --from-beginning Starts a console consumer that reads messages from the beginning (
--from-beginning
) of the specified topic.
Consumer Group Operations
-
List Consumer Groups:
bin/kafka-consumer-groups.sh --list --bootstrap-server localhost:9092
Lists all consumer groups currently active in the Kafka cluster.
-
Describe Consumer Group:
bin/kafka-consumer-groups.sh --describe --group
--bootstrap-server localhost:9092 Provides detailed information about the specified consumer group, including the lag of each consumer in the group.
Kafka Connect
-
List Connectors:
bin/connect-standalone.sh config/connect-standalone.properties
Lists all connectors configured in standalone mode using the specified properties file (
config/connect-standalone.properties
). -
Restart Connectors:
bin/connect-cli.sh
restart Restarts the specified Kafka Connect connector (
<connector_name>
).
Administrative Tasks
-
View Kafka Logs:
tail -f logs/server.log
Displays live updates of Kafka server logs, useful for monitoring and troubleshooting.
-
Change Topic Configuration:
bin/kafka-configs.sh --zookeeper localhost:2181 --entity-type topics --entity-name
--alter --add-config retention.ms=3600000 Modifies the configuration of the specified topic (
<topic_name>
) in the Kafka cluster, in this case, setting the retention period to 1 hour (retention.ms=3600000
).
Conclusion
Mastering Kafka commands is essential for efficient data management and troubleshooting in Kafka environments. Whether you’re creating topics, managing consumer groups, configuring connectors, or monitoring logs, this comprehensive cheat sheet provides the essential commands to streamline your Kafka operations. By leveraging these tools effectively, you can harness Kafka’s power to its fullest extent, ensuring robust data processing capabilities for your applications.