Schema validation in producers in Kafka - Mini Project: Build & Apply

Schema validation in producers

📖 Scenario: You are building a Kafka producer that sends user data messages to a topic. To ensure data quality, you want to validate each message against a predefined schema before sending it.

🎯 Goal: Create a Kafka producer that validates messages against a schema before sending them to the Kafka topic.

📋 What You'll Learn

Create a dictionary called user_data with keys "name", "age", and "email" and exact values "Alice", 30, and "[e-mail]"

Create a dictionary called schema that defines the expected types for "name" as str, "age" as int, and "email" as str

Write a function called validate_schema that takes data and schema and returns True if all keys exist and types match, otherwise False

Print "Valid message sent" if the data passes validation, otherwise print "Invalid message, not sent"

💡 Why This Matters

🌍 Real World

Validating data before sending it to Kafka ensures that consumers receive consistent and expected message formats, reducing errors downstream.

💼 Career

Many jobs require working with Kafka producers and ensuring data quality through schema validation to maintain reliable data pipelines.

1

Create the user data dictionary

Create a dictionary called user_data with these exact entries: "name": "Alice", "age": 30, and "email": "[e-mail]"

Kafka

# Create the user_data dictionary with name, age, and email
# Your code here

Hint

Use curly braces {} to create a dictionary with the exact keys and values.

2

Define the schema dictionary

Create a dictionary called schema with keys "name", "age", and "email" and values str, int, and str respectively

Kafka

user_data = {"name": "Alice", "age": 30, "email": "[e-mail]"}
# Create the schema dictionary with expected types
# Your code here

Hint

Use the Python type names str and int as values in the dictionary.

3

Write the schema validation function

Write a function called validate_schema that takes parameters data and schema and returns True if all keys in schema exist in data and their types match, otherwise returns False

Kafka

user_data = {"name": "Alice", "age": 30, "email": "[e-mail]"}
schema = {"name": str, "age": int, "email": str}
# Define the validate_schema function
# Your code here

Hint

Use a for loop to check each key and isinstance() to check the type.

4

Validate and print the result

Use an if statement to call validate_schema(user_data, schema). If it returns True, print "Valid message sent". Otherwise, print "Invalid message, not sent"

Kafka

user_data = {"name": "Alice", "age": 30, "email": "[e-mail]"}
schema = {"name": str, "age": int, "email": str}

def validate_schema(data, schema):
    for key, expected_type in schema.items():
        if key not in data or not isinstance(data[key], expected_type):
            return False
    return True

# Validate user_data and print the result
# Your code here

Hint

Use if to check the function result and print() to show the message.

Practice

1. What is the main purpose of schema validation in Kafka producers?

easy

A. To compress messages for storage

B. To speed up message delivery in Kafka

C. To ensure data sent matches the expected format and structure

D. To encrypt messages before sending

Solution

1. Step 1: Understand schema validation role

   Schema validation checks if data matches a predefined format or structure.

2. Step 2: Identify producer's goal

   Producers use schema validation to keep data clean and consistent before sending.

3. Final Answer:

   To ensure data sent matches the expected format and structure -> Option C

4. Quick Check:

   Schema validation = data format check [OK]

Hint: Schema validation means checking data format before sending [OK]

Common Mistakes:

• Confusing validation with encryption
• Thinking it speeds up message delivery
• Assuming it compresses data

2. Which configuration is essential for KafkaAvroSerializer to validate schemas in a producer?

easy

A. bootstrap.servers

B. schema.registry.url

C. acks

D. compression.type

Solution

1. Step 1: Identify serializer requirements

   KafkaAvroSerializer needs to connect to the schema registry to validate schemas.

2. Step 2: Find the required config key

   The key 'schema.registry.url' tells the serializer where to find the schema registry.

3. Final Answer:

   schema.registry.url -> Option B

4. Quick Check:

   Schema registry URL = validation source [OK]

Hint: Set schema.registry.url for schema validation [OK]

Common Mistakes:

• Using bootstrap.servers for schema validation
• Confusing acks with schema config
• Missing schema.registry.url causes validation failure

3. Given this producer code snippet using KafkaAvroSerializer:

props.put("schema.registry.url", "http://localhost:8081");
ProducerRecord record = new ProducerRecord<>("topic", userRecord);
producer.send(record);

What happens if userRecord does not match the registered schema?

medium

A. A serialization exception is thrown and message is not sent

B. The producer retries sending the message indefinitely

C. The message is sent successfully without validation

D. The message is sent but schema registry logs a warning

Solution

1. Step 1: Understand KafkaAvroSerializer behavior

   It validates data against the schema before sending.

2. Step 2: Check what happens on mismatch

   If data doesn't match, serialization fails and an exception is thrown, preventing send.

3. Final Answer:

   A serialization exception is thrown and message is not sent -> Option A

4. Quick Check:

   Schema mismatch = serialization error [OK]

Hint: Mismatch triggers serialization exception, no send [OK]

Common Mistakes:

• Assuming message sends without validation
• Thinking producer retries endlessly
• Believing only warnings are logged

4. You see this error when sending a message: io.confluent.kafka.schemaregistry.client.rest.exceptions.RestClientException: 404 Not Found. What is the most likely cause related to schema validation?

medium

A. The schema registry URL is incorrect or unreachable

B. The producer topic does not exist

C. The message key is null

D. The Kafka broker is down

Solution

1. Step 1: Analyze the error message

   404 Not Found means the client can't reach the schema registry endpoint.

2. Step 2: Connect error to schema validation

   If schema registry URL is wrong or server is down, validation fails with this error.

3. Final Answer:

   The schema registry URL is incorrect or unreachable -> Option A

4. Quick Check:

   404 error = schema registry URL issue [OK]

Hint: 404 error means schema registry URL problem [OK]

Common Mistakes:

• Blaming topic existence for 404
• Assuming null key causes this error
• Thinking Kafka broker down causes 404

5. You want to produce messages with optional fields that may or may not be present in your Avro schema. How should you configure your producer and schema to allow schema validation to pass when some fields are missing?

hard

A. Send empty strings for missing fields to pass validation

B. Remove optional fields from the schema and send messages without them

C. Disable schema validation in the producer configuration

D. Define optional fields with default values in the Avro schema and use KafkaAvroSerializer with schema.registry.url set

Solution

1. Step 1: Understand optional fields in Avro

   Optional fields must have default values in the schema to allow missing data.

2. Step 2: Configure producer for validation

   Use KafkaAvroSerializer with schema.registry.url set to validate against schema with defaults.

3. Final Answer:

   Define optional fields with default values in the Avro schema and use KafkaAvroSerializer with schema.registry.url set -> Option D

4. Quick Check:

   Defaults + serializer config = optional fields allowed [OK]

Hint: Use defaults in schema for optional fields [OK]

Common Mistakes:

• Removing fields instead of using defaults
• Disabling validation instead of fixing schema
• Sending empty strings instead of omitting fields