Event schema design in Microservices - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an event schema in microservices?

An event schema defines the structure and format of data sent in an event message between microservices. It ensures all services understand the event data consistently.

intermediate

Why is versioning important in event schema design?

Versioning allows changes to event schemas without breaking existing consumers. It helps services evolve independently while maintaining compatibility.

beginner

Name two common formats used for event schemas.

JSON and Avro are common formats for event schemas. JSON is human-readable, while Avro is compact and supports schema evolution.

intermediate

What is the role of a schema registry in event-driven systems?

A schema registry stores and manages event schemas centrally. It helps producers and consumers validate and evolve schemas safely.

advanced

How can you ensure backward compatibility in event schema changes?

To ensure backward compatibility, add new optional fields instead of removing or changing existing ones. Consumers can ignore unknown fields safely.

What does an event schema primarily define?

A The structure of event data

B The network protocol used

C The database schema

D The UI layout

An event schema defines the structure and format of the event data sent between services.

Which format is NOT commonly used for event schemas?

A Avro

B Markdown

C XML

D JSON

Markdown is a text formatting syntax, not used for event schemas.

Why use a schema registry in microservices?

A To store and manage event schemas centrally

B To store user credentials

C To manage UI components

D To monitor network traffic

A schema registry helps manage event schemas centrally for validation and evolution.

What is a safe way to change an event schema without breaking consumers?

A Remove existing fields

B Change field types

C Rename fields

D Add new optional fields

Adding new optional fields keeps old consumers working without errors.

Versioning in event schemas helps to:

A Encrypt event data

B Prevent any schema changes

C Allow schema changes without breaking consumers

D Improve network speed

Versioning allows schemas to evolve while keeping compatibility.

Explain what an event schema is and why it matters in microservices.

Think about how services understand each other when sending messages.

Describe best practices for evolving event schemas without breaking existing consumers.

Consider how to keep old and new services working together smoothly.

Practice

1. What is the main purpose of an event schema in microservices?

easy

A. To define the structure and content of messages exchanged between services

B. To store user data in a database

C. To create user interfaces for microservices

D. To manage network connections between services

Solution

1. Step 1: Understand event schema role

   An event schema defines how messages look when services talk to each other.

2. Step 2: Identify correct purpose

   It ensures all services understand the message format and data.

3. Final Answer:

   To define the structure and content of messages exchanged between services -> Option A

4. Quick Check:

   Event schema = message format [OK]

Hint: Event schema = message format for services [OK]

Common Mistakes:

• Confusing event schema with database storage
• Thinking event schema manages UI or network
• Assuming event schema is about service deployment

2. Which of the following is a correct JSON snippet for an event schema with type and timestamp?

easy

A. {eventType: "OrderCreated", "timestamp": "2024-06-01T12:00:00Z"}

B. {"eventType": OrderCreated, "timestamp": 2024-06-01T12:00:00Z}

C. {"eventType": "OrderCreated", timestamp: "2024-06-01T12:00:00Z"}

D. {"eventType": "OrderCreated", "timestamp": "2024-06-01T12:00:00Z"}

Solution

1. Step 1: Check JSON syntax rules

   Keys and string values must be in double quotes; commas separate pairs.

2. Step 2: Validate each option

   {"eventType": "OrderCreated", "timestamp": "2024-06-01T12:00:00Z"} uses correct quotes and format; others miss quotes or have invalid syntax.

3. Final Answer:

   {"eventType": "OrderCreated", "timestamp": "2024-06-01T12:00:00Z"} -> Option D

4. Quick Check:

   Valid JSON = {"eventType": "OrderCreated", "timestamp": "2024-06-01T12:00:00Z"} [OK]

Hint: JSON keys and strings need double quotes [OK]

Common Mistakes:

• Missing quotes around keys or string values
• Using unquoted date/time strings
• Omitting commas between pairs

3. Given this event schema snippet:

{"eventType": "UserSignedUp", "timestamp": "2024-06-01T10:00:00Z", "data": {"userId": 123, "email": "[e-mail]"}}

What will be the value of data.email in the event?

medium

A. 123

B. "UserSignedUp"

C. "[e-mail]"

D. 2024-06-01T10:00:00Z

Solution

1. Step 1: Locate the data field in the event

   The event has a nested object under "data" with keys "userId" and "email".

2. Step 2: Identify the value of data.email

   The value for "email" is "[e-mail]" as a string.

3. Final Answer:

   "[e-mail]" -> Option C

4. Quick Check:

   data.email = "[e-mail]" [OK]

Hint: Look inside data object for email key [OK]

Common Mistakes:

• Confusing userId with email
• Picking eventType or timestamp instead
• Ignoring nested structure

4. Identify the error in this event schema:

{"eventType": "PaymentProcessed", "timestamp": "2024-06-01T15:00:00Z", "data": {"amount": 100, "currency": USD}}

medium

A. Missing comma after amount key

B. Missing quotes around the currency value USD

C. timestamp format is incorrect

D. eventType should be lowercase

Solution

1. Step 1: Check JSON value types

   String values must be in double quotes; USD is unquoted here.

2. Step 2: Verify other parts

   Comma after amount is present, timestamp format is ISO standard, eventType case is allowed.

3. Final Answer:

   Missing quotes around the currency value USD -> Option B

4. Quick Check:

   Strings need quotes [OK]

Hint: String values must have quotes in JSON [OK]

Common Mistakes:

• Ignoring missing quotes on string values
• Thinking timestamp format is wrong
• Assuming key case matters in JSON

5. You want to design an event schema for a microservice that sends user profile updates. Which design choice improves schema flexibility for future changes?

hard

A. Include a 'metadata' field to hold optional extra info

B. Fix the schema to only allow 'name' and 'email' fields

C. Use a flat schema without nested objects

D. Exclude timestamps to reduce message size

Solution

1. Step 1: Understand schema flexibility needs

   Flexible schemas allow adding new info without breaking existing services.

2. Step 2: Evaluate options for flexibility

   Adding a 'metadata' field lets you add optional data later safely.

3. Final Answer:

   Include a 'metadata' field to hold optional extra info -> Option A

4. Quick Check:

   Optional metadata = flexible schema [OK]

Hint: Add metadata field for optional future data [OK]

Common Mistakes:

• Fixing schema too rigidly limits future changes
• Removing timestamps loses event timing info
• Avoiding nested objects reduces clarity