Python producer (confluent-kafka) - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of a Python producer in the context of Kafka?

A Python producer sends messages (data) to Kafka topics so that other applications can consume them later.

beginner

Which Python library is commonly used to create a Kafka producer?

The confluent-kafka library is commonly used because it is fast and reliable for producing messages to Kafka.

beginner

What is the role of the <code>Producer</code> class in <code>confluent-kafka</code>?

The <code>Producer</code> class creates a producer client that connects to Kafka and sends messages to specified topics.

intermediate

Why do we use a delivery callback function in a Kafka producer?

A delivery callback confirms if a message was successfully sent or if there was an error, helping to track message delivery status.

intermediate

What is the purpose of calling producer.flush() in a Kafka producer script?

Calling producer.flush() waits for all messages in the producer queue to be sent before the program exits, ensuring no messages are lost.

Which method is used to send a message to a Kafka topic using confluent-kafka's Producer?

A send()

B produce()

C publish()

D write()

The produce() method is used to send messages to Kafka topics with the confluent-kafka Producer.

What parameter must you provide when creating a Producer to connect to Kafka?

A bootstrap.servers

B topic.name

C group.id

D client.id

The bootstrap.servers parameter specifies the Kafka broker addresses to connect the producer.

What does the delivery callback function receive as arguments?

A Producer instance and message key

B Topic name and partition number

C Timestamp and offset

D Error and Message objects

The delivery callback receives an error object (if any) and the message object to confirm delivery status.

Why is it important to call producer.flush() before ending the program?

A To clear the message queue

B To close the Kafka connection

C To ensure all messages are sent

D To reset the producer configuration

producer.flush() waits for all queued messages to be delivered before the program exits.

Which of these is NOT a valid configuration key for the Producer?

A max.poll.records

B acks

C client.id

D bootstrap.servers

max.poll.records is a consumer configuration, not used for the producer.

Explain how to create and use a Kafka producer in Python with confluent-kafka to send a message.

Think about the steps from setup to sending and confirming message delivery.

Describe the role of the delivery callback function in a Kafka producer and why it is useful.

Consider how you know if your message reached Kafka safely.

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