Correlation IDs in Microservices - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to generate a unique correlation ID for each request.

Microservices

import uuid

def generate_correlation_id():
    return str([1].uuid4())

Drag options to blanks, or click blank then click option'

Auuid

Brandom

Ctime

Dhashlib

Attempts:

3 left

💡 Hint

Common Mistakes

Using random module which does not guarantee uniqueness.

Using time module which can cause collisions under high load.

The uuid module provides a simple way to generate unique IDs using uuid4().

2fill in blank

medium

Complete the code to attach the correlation ID to the HTTP request headers.

Microservices

def add_correlation_id_header(request, correlation_id):
    request.headers[[1]] = correlation_id

Drag options to blanks, or click blank then click option'

AContent-Type

BAuthorization

CUser-Agent

DX-Request-ID

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'Authorization' header which is for security tokens.

Using 'Content-Type' which specifies data format.

The X-Request-ID header is commonly used to pass correlation IDs in HTTP requests.

3fill in blank

hard

Fix the error in the code that extracts the correlation ID from incoming request headers.

Microservices

def get_correlation_id(request):
    return request.headers.get([1], None)

Drag options to blanks, or click blank then click option'

AX-Request-ID

BX-Correlation-ID

Ccorrelation-id

DRequest-ID

Attempts:

3 left

💡 Hint

Common Mistakes

Using lowercase or incorrect header names causing missing IDs.

Using 'X-Correlation-ID' which is less common than 'X-Request-ID'.

The standard header to extract correlation IDs is X-Request-ID, matching what was set earlier.

4fill in blank

hard

Fill both blanks to create a middleware function that logs the correlation ID for each request.

Microservices

def middleware(request):
    correlation_id = get_correlation_id(request) or generate_correlation_id()
    log_message = f"Processing request with [1]: {correlation_id}"
    [2](log_message)
    # continue processing request

Drag options to blanks, or click blank then click option'

ACorrelation-ID

Bprint

Clogger.info

DCorrelationId

Attempts:

3 left

💡 Hint

Common Mistakes

Using print instead of logger.info for logging.

Using incorrect label names that don't match correlation ID headers.

The log message should mention Correlation-ID and use logger.info to log it properly.

5fill in blank

hard

Fill all three blanks to propagate the correlation ID through multiple microservices calls.

Microservices

def call_service(service_url, correlation_id):
    headers = { [1]: correlation_id }
    response = http_client.get(service_url, headers=[2])
    if response.status_code == 200:
        return response.json().get([3])
    return None

Drag options to blanks, or click blank then click option'

AX-Request-ID

Bheaders

Cdata

DX-Correlation-ID

Attempts:

3 left

💡 Hint

Common Mistakes

Using wrong header keys causing correlation ID loss.

Passing wrong variable names to HTTP client.

Extracting incorrect keys from response JSON.

Use X-Request-ID as the header key, pass the headers dictionary to the HTTP client, and extract data from the JSON response.

Practice

1. What is the primary purpose of a Correlation ID in microservices?

easy

A. To balance load between servers

B. To encrypt data between services

C. To track a single request across multiple services for easier debugging

D. To store user session information

Solution

1. Step 1: Understand the role of Correlation ID

   A Correlation ID is a unique identifier attached to a request that travels through multiple services.

2. Step 2: Identify its main use

   This ID helps developers trace and debug the flow of that request across distributed systems.

3. Final Answer:

   To track a single request across multiple services for easier debugging -> Option C

4. Quick Check:

   Correlation ID = request tracking [OK]

Hint: Correlation ID links logs of one request across services [OK]

Common Mistakes:

• Confusing Correlation ID with encryption keys
• Thinking it balances load
• Assuming it stores user data

2. Which of the following is the correct way to pass a Correlation ID between microservices?

easy

A. Add it as a custom HTTP header in the request

B. Include it as a query parameter in the URL

C. Store it in a database before each call

D. Embed it inside the response body

Solution

1. Step 1: Review common practices for passing metadata

   Metadata like Correlation IDs are typically passed in HTTP headers to keep requests clean and consistent.

2. Step 2: Evaluate options

   Query parameters can be altered or logged insecurely; storing in DB is inefficient; response body is too late for tracking.

3. Final Answer:

   Add it as a custom HTTP header in the request -> Option A

4. Quick Check:

   Correlation ID in headers = best practice [OK]

Hint: Use HTTP headers to pass Correlation IDs [OK]

Common Mistakes:

• Using query parameters which can be insecure
• Storing IDs in database for each call
• Embedding IDs in response body instead of request

3. Consider this simplified code snippet in a microservice receiving an HTTP request:

def handle_request(request):
    correlation_id = request.headers.get('X-Correlation-ID')
    log(f"Start processing request {correlation_id}")
    # ... process ...
    log(f"End processing request {correlation_id}")

What will be logged if the incoming request has header X-Correlation-ID: abc123?

medium

A. No logs will be generated

B. Start processing request abc123
End processing request abc123

C. Start processing request X-Correlation-ID
End processing request X-Correlation-ID

D. Start processing request None
End processing request None

Solution

1. Step 1: Extract Correlation ID from headers

   The code uses request.headers.get('X-Correlation-ID') which returns the header value if present.

2. Step 2: Check the header value in the request

   The request has X-Correlation-ID: abc123, so correlation_id will be 'abc123'.

3. Final Answer:

   Start processing request abc123 End processing request abc123 -> Option B

4. Quick Check:

   Header value read correctly = logs with abc123 [OK]

Hint: Headers.get returns value or None; here value exists [OK]

Common Mistakes:

• Assuming header key is logged instead of value
• Thinking None is logged when header exists
• Believing no logs are generated

4. A developer notices that Correlation IDs are missing in logs of downstream services. Which is the most likely cause?

medium

A. The Correlation ID header is not forwarded in outgoing requests

B. The Correlation ID is too long and gets truncated

C. The logging system does not support string messages

D. The services are using different programming languages

Solution

1. Step 1: Understand Correlation ID propagation

   Correlation IDs must be passed along with every outgoing request to maintain traceability.

2. Step 2: Identify common propagation mistake

   If downstream logs miss the ID, it usually means the header was not forwarded properly.

3. Final Answer:

   The Correlation ID header is not forwarded in outgoing requests -> Option A

4. Quick Check:

   Missing ID in logs = header not forwarded [OK]

Hint: Always forward Correlation ID header downstream [OK]

Common Mistakes:

• Blaming length truncation without evidence
• Assuming logging system limitation
• Thinking language differences cause missing IDs

5. You design a microservices system where each service generates its own Correlation ID if none is provided. What is a potential problem with this approach?

hard

A. It ensures better security by hiding original IDs

B. It improves performance by reducing header size

C. It simplifies logging by having unique IDs per service

D. It breaks the traceability because multiple IDs exist for the same request

Solution

1. Step 1: Analyze the effect of generating new IDs per service

   If each service creates a new Correlation ID, the original request's trace is lost.

2. Step 2: Understand impact on traceability

   Multiple different IDs for one request make it impossible to follow the full request path across services.

3. Final Answer:

   It breaks the traceability because multiple IDs exist for the same request -> Option D

4. Quick Check:

   Multiple IDs = broken traceability [OK]

Hint: One Correlation ID per request across services only [OK]

Common Mistakes:

• Thinking multiple IDs improve security
• Assuming performance improves with new IDs
• Believing unique IDs per service simplify logs