Correlation IDs in Microservices - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Correlation ID in microservices?

A Correlation ID is a unique identifier attached to a request that travels through multiple microservices. It helps track and trace the request across different services for debugging and monitoring.

beginner

Why are Correlation IDs important in distributed systems?

They allow developers to follow a request's path through many services, making it easier to find where errors or delays happen. This improves troubleshooting and system observability.

intermediate

How is a Correlation ID typically passed between microservices?

It is usually passed as a header in HTTP requests or as metadata in messaging systems, ensuring every service handling the request can log and forward the same ID.

intermediate

What happens if a Correlation ID is missing in a request?

The first service usually generates a new Correlation ID to start tracking. Without it, tracing the request end-to-end becomes difficult or impossible.

advanced

Name one best practice when implementing Correlation IDs.

Always generate the Correlation ID at the edge of the system (like API gateway) and ensure it is included in all logs and passed to downstream services.

What is the main purpose of a Correlation ID in microservices?

A To uniquely identify and trace a request across multiple services

B To encrypt data between services

C To balance load between servers

D To store user credentials securely

Correlation IDs help track requests across services, not for encryption, load balancing, or storing credentials.

Where is a Correlation ID usually stored when passing between services?

A In the user's browser cookies

B In HTTP headers or message metadata

C In the service's environment variables

D In the database only

Correlation IDs travel with requests, so they are passed in headers or message metadata, not stored only in databases or environment variables.

If a request arrives without a Correlation ID, what should happen?

A The first service generates a new Correlation ID

B The request is rejected immediately

C The request is processed without tracking

D The Correlation ID is fetched from a cache

To maintain traceability, the first service creates a new Correlation ID if missing.

Which of the following is NOT a benefit of using Correlation IDs?

A Easier performance analysis

B Better request traceability

C Improved debugging and monitoring

D Automatic data encryption

Correlation IDs do not provide encryption; they help with tracing and monitoring.

Best practice for Correlation IDs includes:

A Not logging the ID to avoid clutter

B Changing the ID at every service

C Generating the ID at the system edge and passing it downstream

D Using random IDs for each service call

The ID should be generated once and passed along unchanged to maintain traceability.

Explain what a Correlation ID is and how it helps in microservices.

Think about how you follow a package delivery across multiple stops.

Describe the best practices for implementing Correlation IDs in a distributed system.

Consider how a tracking number stays the same from sender to receiver.

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