Python producer (confluent-kafka) - Commands & Configuration

Introduction

Sending messages to Kafka topics can be tricky without the right tools. The Python producer from confluent-kafka helps you send data easily and reliably to Kafka servers using simple Python code.

When you want to send user activity logs from a Python app to Kafka for processing.

When you need to stream sensor data from a Python script to a Kafka topic for real-time analysis.

When you want to build a Python service that pushes notifications into Kafka for other services to consume.

When you want to test Kafka message flow by producing sample messages from Python.

When you want to integrate Python applications with Kafka without writing complex Java code.

Commands

This command installs the confluent-kafka Python library, which provides the Kafka producer functionality.

Terminal

pip install confluent-kafka

Expected Output

Collecting confluent-kafka

  Downloading confluent_kafka-2.1.1-cp39-cp39-manylinux2014_x86_64.whl (1.3 MB)

Installing collected packages: confluent-kafka

Successfully installed confluent-kafka-2.1.1

Runs the Python script that sends a message to the Kafka topic using the confluent-kafka producer.

Terminal

python produce_message.py

Expected Output

Message delivered to topic 'example-topic' partition [0] at offset 15

Key Concept

If you remember nothing else from this pattern, remember: the confluent-kafka Python producer sends messages asynchronously and requires a delivery callback to confirm success.

Code Example

Kafka

from confluent_kafka import Producer

conf = {'bootstrap.servers': 'localhost:9092'}
producer = Producer(conf)

def delivery_report(err, msg):
    if err is not None:
        print(f'Message delivery failed: {err}')
    else:
        print(f"Message delivered to topic '{msg.topic()}' partition [{msg.partition()}] at offset {msg.offset()}")

producer.produce('example-topic', key='key1', value='Hello Kafka!', callback=delivery_report)
producer.flush()

Common Mistakes

Not installing the confluent-kafka library before running the script.

The Python script will fail with a ModuleNotFoundError because the library is missing.

Always run 'pip install confluent-kafka' before executing the producer script.

Not flushing the producer after sending messages.

Messages may remain in the buffer and not be sent to Kafka, causing data loss.

Call producer.flush() after producing messages to ensure delivery.

Using incorrect Kafka broker address or topic name.

The producer cannot connect or send messages, resulting in errors or silent failures.

Verify the broker address and topic name are correct and accessible.

Summary

Install the confluent-kafka Python library to enable Kafka message production.

Write a Python script that creates a Producer, sends a message with a delivery callback, and flushes the producer.

Run the script to send messages and confirm delivery with printed output.

Practice

1. What is the main purpose of the produce() method in the Python confluent-kafka producer?

easy

A. To consume messages from a Kafka topic

B. To connect to the Kafka server

C. To send a message to a Kafka topic

D. To wait for all messages to be delivered

Solution

1. Step 1: Understand the role of produce()

   The produce() method is used to send messages to a Kafka topic from the producer.

2. Step 2: Differentiate from other methods

   flush() waits for messages to be sent, and connection is set by configuration, not produce().

3. Final Answer:

   To send a message to a Kafka topic -> Option C

4. Quick Check:

   produce() sends messages [OK]

Hint: Remember: produce() means send message [OK]

Common Mistakes:

• Confusing produce() with flush()
• Thinking produce() connects to Kafka
• Mixing producer and consumer roles

2. Which of the following is the correct way to set the Kafka server address in the Python confluent-kafka producer configuration?

easy

A. "bootstrap.servers" : "localhost:9092"

B. "server.bootstrap" : "localhost:9092"

C. "kafka.server" : "localhost:9092"

D. "broker.address" : "localhost:9092"

Solution

1. Step 1: Recall the correct configuration key

   The correct key to specify Kafka server address is bootstrap.servers.

2. Step 2: Match the option

   Only "bootstrap.servers" : "localhost:9092" uses the exact key "bootstrap.servers" with a valid address format.

3. Final Answer:

   "bootstrap.servers" : "localhost:9092" -> Option A

4. Quick Check:

   Kafka server config = bootstrap.servers [OK]

Hint: Look for exact key: bootstrap.servers [OK]

Common Mistakes:

• Swapping key names like server.bootstrap
• Using incorrect keys like kafka.server
• Missing quotes or wrong format

3. What will be the output of the following Python code using confluent-kafka producer?

from confluent_kafka import Producer

p = Producer({'bootstrap.servers': 'localhost:9092'})
p.produce('my_topic', key='key1', value='hello')
p.flush()
print('Message sent')

medium

A. Error: No Kafka server found

B. hello

C. No output

D. Message sent

Solution

1. Step 1: Understand the code flow

   The code creates a producer, sends a message to 'my_topic', waits for delivery with flush(), then prints 'Message sent'.

2. Step 2: Identify the printed output

   The only print statement outputs the string 'Message sent'. The message sending is asynchronous but flush ensures completion before print.

3. Final Answer:

   Message sent -> Option D

4. Quick Check:

   flush() waits, then print runs [OK]

Hint: flush() waits, print runs after sending [OK]

Common Mistakes:

• Expecting message value to print
• Ignoring flush() effect
• Assuming error without Kafka running

4. Identify the error in this Python confluent-kafka producer code:

from confluent_kafka import Producer

p = Producer({'bootstrap.servers': 'localhost:9092'})
p.produce('my_topic', key='key1', 'hello')
p.flush()

medium

A. Missing key argument in produce()

B. Incorrect order of arguments in produce()

C. flush() called before produce()

D. Missing import statement

Solution

1. Step 1: Check produce() argument order

   The produce() method expects positional arguments first (topic, optionally value), followed only by keyword arguments. Here, key='key1' (keyword) is followed by 'hello' (positional), causing SyntaxError: positional argument follows keyword argument.

2. Step 2: Identify correct usage

   Correct usage: produce('my_topic', value='hello') or produce('my_topic', key='key1', value='hello').

3. Final Answer:

   Incorrect order of arguments in produce() -> Option B

4. Quick Check:

   Positional args before keywords [OK]

Hint: Positional args must precede keywords [OK]

Common Mistakes:

• Placing positional argument after keyword argument
• Mixing positional and keyword argument order
• Forgetting Python positional-before-keyword rule

5. You want to send multiple messages to Kafka and ensure all are delivered before your program exits. Which sequence of calls is correct using confluent-kafka producer in Python?

hard

A. Call produce() for each message, then call flush() once at the end

B. Call flush() after each produce() call

C. Call flush() before any produce() calls

D. Call produce() once, then call flush() multiple times

Solution

1. Step 1: Understand message sending behavior

   produce() queues messages asynchronously. Calling it multiple times queues multiple messages.

2. Step 2: Use flush() to wait for delivery

   Calling flush() once after all produce() calls waits for all messages to be sent before program exit.

3. Final Answer:

   Call produce() for each message, then call flush() once at the end -> Option A

4. Quick Check:

   Produce many, flush once after all [OK]

Hint: Flush once after all produce calls to wait [OK]

Common Mistakes:

• Flushing after every produce (slow)
• Flushing before producing messages
• Not flushing at all causing lost messages