Why Request Correlation IDs Disappear Between Services
Trace missing correlation ids across browsers, gateways, queues and microservices so API incidents can be followed end to end.
Quick Answer
Correlation IDs disappear when a service fails to forward the header, a gateway renames it, CORS hides it from browser code, a queue message drops metadata, or a new request is created without linking to the parent. Propagate one stable id and log it at every boundary.
Example Scenario
A user reports a failed import. The frontend has one request id, the gateway has another and the worker logs have none. The operation crossed HTTP and queue boundaries, but metadata was not propagated consistently.
Step-by-Step Explanation
- Choose the correlation header name.
- Log the id at ingress and egress.
- Forward it through proxies and service clients.
- Attach it to queue messages and jobs.
- Expose safe ids to support when useful.
- Test propagation across failure paths.
Start by Naming the Contract That Broke
Correlation IDs disappear between services when propagation is treated as optional metadata. Debugging is slower when every symptom is treated as a generic API failure. Name the contract first: request shape, response shape, retry behavior, file type, time zone, numeric precision, logging policy or delivery semantics. Once the contract is named, each observation has a place to belong.
The most useful first signal is usually a trace that stops at a gateway or worker boundary. It tells you which boundary produced the failure and prevents the team from rewriting unrelated client code. Keep the original request, response or log line available while you investigate.
A good working note should say what was expected, what actually happened and which layer observed it. That note is more valuable than a screenshot of a stack trace because it can be compared with documentation, tests and production logs.
If the issue is intermittent, keep one failing sample and one passing sample from the same release window. The passing sample prevents overfitting the fix to one user, while the failing sample keeps the investigation grounded in evidence instead of guesses about the system.
Separate Symptoms from Evidence
The visible symptom may be different ids for one user-visible operation, but the evidence should be more precise. Capture ingress and egress logs for each service hop, then compare it with a successful case from the same environment. Environment, user role and feature flag differences can otherwise look like code regressions.
Avoid starting with broad fixes. First check header forwarding and queue metadata configuration. If that detail differs from the healthy request, you have a concrete lead. If it matches, move to the next layer instead of guessing.
When multiple teams are involved, preserve the raw evidence in a safe form. Redact secrets, but keep field names, status codes, headers, timestamps and request ids. Sanitized evidence still lets another team reproduce the reasoning.
Look for Boundary Translation Errors
Many production bugs happen when data crosses a boundary and changes meaning. A browser form, generated client, proxy, queue worker, database mapper or logging pipeline can transform the value before the final system sees it.
For this issue, inspect the first boundary where the id changed or vanished. That is where small differences usually become visible. A value may still look reasonable to a human while failing the receiver's stricter expectation.
Use comparison tools when the payload is large. Diff the failing sample against a known-good sample, then reduce it to the smallest input that still fails. A minimal failing sample turns a vague incident into a contract discussion.
Boundary errors also need ownership clarity. Decide which component is allowed to transform the value and which component must reject it. Without that decision, every layer may add a small compatibility patch, and the system becomes harder to reason about after the incident.
Choose a Fix That Matches the Failure Mode
The first safe fix is often centralizing correlation id middleware. It addresses the observed boundary instead of hiding the symptom. If the problem is a contract mismatch, the fix should update the producer, consumer or documented contract deliberately.
The second fix to consider is copying ids into queue metadata and background jobs. This is useful when old clients, partner integrations or delayed deployments mean two shapes must be accepted for a short time. Compatibility should be explicit and temporary where possible.
A third option is returning a safe request id to the client for support. Use this when the system needs better operational visibility before making a behavioral change. Good diagnostics can prevent a small correction from becoming a larger regression.
Keep Production Diagnostics Safe
Diagnostics should explain the failure without exposing sensitive data. For this topic, useful logs include request id, status code, safe field paths, environment and a short reason code. They should not include tokens, full personal records or secret payloads.
If the failure reaches support, include correlation id, parent id and operation id logged consistently. That gives the next debugger a trail without requiring access to private customer data. It also helps separate one-off bad input from a systemic contract drift.
When adding logs, add deletion and retention awareness. Debug logs that are safe today can become risky if they accumulate raw payloads for months. Prefer structured fields over copied bodies.
A safe diagnostic should also be cheap to leave in place. If it requires developers to enable raw payload logging during every incident, the next emergency will recreate the same privacy and security risk. Prefer stable reason codes, counters and compact metadata that can remain active in production.
Prevention Checklist
Add a regression test for HTTP-to-queue and error-path propagation tests. The test should fail when the boundary behavior changes unexpectedly. A small test around the contract is often more valuable than a broad snapshot that nobody reviews.
Review gateway and service client header rules during release during release. Many bugs in this category appear during rolling deploys, integration updates or data migrations, not during a clean local run.
Document which id names are canonical and which are legacy aliases. The goal is not a long policy page; it is a short, accurate rule that future developers can apply while changing the same path.
After the fix, replay the original failing case and one known-good case. If both behave correctly, record the evidence in the incident or changelog. This closes the loop and keeps the next investigation from starting over.
Code Examples
const correlationId = request.headers.get('x-correlation-id') || crypto.randomUUID();await fetch(upstreamUrl, { headers: { 'X-Correlation-ID': correlationId } });console.log({ correlationId, operationId, service: 'import-worker', status });Common Mistakes
- Generating a new id at every service.
- Forwarding ids on success paths but not errors.
- Dropping metadata when moving to queues.
- Using many header names without a canonical one.
- Logging ids in one service but not the next.
FAQ
Is correlation id the same as request id?
Not always. A request id may identify one hop; a correlation id follows the broader operation.
Should the browser see the id?
Often yes, if it is safe and useful for support.
Do queues need correlation ids?
Yes. Async work needs metadata propagation too.
Where do traces usually break?
Gateways, background jobs and error handlers are common breakpoints.