Skip to content

feat: add request correlation IDs #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Heet27 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: add request correlation IDs #298

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
745d018
feat: add request correlation IDs
Heet27 Jul 25, 2026
159eecc
fix: address middleware lint checks
Heet27 Jul 25, 2026
637e924
feat: add request correlation IDs and address Bandit findings
Heet27 Jul 25, 2026
a0391b0
fix: correct auth callback indentation
Heet27 Jul 25, 2026
27335af
chore: revert unintended dependency changes
Heet27 Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 27 additions & 9 deletions backend-api/app/core/middleware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,42 @@
import logging
import time
from uuid import uuid4

from starlette.middleware.base import BaseHTTPMiddleware

logger = logging.getLogger("api")

REQUEST_ID_HEADER = "X-Request-ID"
MAX_REQUEST_ID_LENGTH = 128


class RequestLoggingMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request, call_next):
start_time = time.time()

# Process request
supplied_request_id = request.headers.get(REQUEST_ID_HEADER)

if supplied_request_id and len(supplied_request_id) <= MAX_REQUEST_ID_LENGTH:
request_id = supplied_request_id
else:
request_id = str(uuid4())

request.state.request_id = request_id

response = await call_next(request)

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve correlation IDs on unhandled failures

When an endpoint or dependency raises an unhandled exception, call_next propagates it before the response header and request log are written. Starlette's outer ServerErrorMiddleware then creates the 500 response after this middleware has exited, so that response has no X-Request-ID and no correlation log—the failure scenario where the ID is most needed. Handle this path so the generated or supplied ID is logged and included on the resulting error response.

Useful? React with 👍 / 👎.


duration = round(time.time() - start_time, 3)

# Log only metadata
logger.info({
"method": request.method,
"path": request.url.path,
"status_code": response.status_code,
"duration": duration
})
response.headers[REQUEST_ID_HEADER] = request_id

logger.info(
{
"request_id": request_id,
"method": request.method,
"path": request.url.path,
"status_code": response.status_code,
"duration": duration,
}
)

return response
return response
Loading