Repository navigation
improvement(logs): move correlation ids from message tags into metadata and enforce it - #9724
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
 [High impact] The PR appears safe to merge, with non-blocking checker and log-correlation issues remaining. Findings
SummaryMoves correlation ids from log messages into fields and adds a check against putting them back.
Reviews (2) · Last reviewed commit: "fix(logs): export call fields to OpenTel..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 325 files
Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.
Turn on auto-fix | Re-trigger cubic
Collaborator
Author
Collaborator
Author
|
@cubic-dev-ai review this PR |
Contributor
@waleedlatif1 I have started the AI code review. It will take a few minutes to complete. |
Contributor
There was a problem hiding this comment.
No issues found across 331 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.
Turn on auto-fix | Re-trigger cubic
…ta and enforce it
Log messages no longer open with an interpolated [${id}] tag or interpolate a request id. The id moves into the line's metadata, so messages group in queries and lines filter by field. Inside withRouteHandler a generateRequestId() id is already stamped on every line by the request context, so those tags are dropped without a field.
Routes, table runners, the Sim event emitter and the poll orchestrator that minted their own correlation ids now use generateRequestId(), so their lines carry the request's id. Each webhook poll logs through a logger bound to its webhook id, so concurrent polls in one tick stay distinguishable.
check:source-conventions gains log-message-tag: it covers every app and package that imports @sim/logger, follows a message through concatenation, ternaries, local consts and helpers handed the caller's logger, and starts at zero.
…elds from erasing it An explicit requestId on a line, or one bound with withMetadata, replaced the request context's id in the JSON line, and an undefined one deleted it, so a line could stop correlating with its request. Inside a request context the context's id is now authoritative, matching the OpenTelemetry export; a requestId passed with a line names the request only outside one. Undefined fields no longer erase fields the line already carries. v2 chat logs its mothership request id as simRequestId. Request ids that defaulted to 'unknown' default to generateRequestId(). log-message-tag now sees optional calls, computed levels, withMetadata-derived loggers and log-named receivers, follows let prefixes, resolves names per function, and only treats an interpolated requestId or reqId, and log* helpers or .call(logger), as message sources.
…event Executions started by one poll tick, or by one parent request, would otherwise share a request id, and tool code that keys idempotency on it (deployments) could replay one execution's result in another. The logger now owns requestId on the line, so these ids no longer need to match the request to correlate.
…lls apart Scalar fields passed with a log line now become OpenTelemetry attributes, matching their top-level keys in the JSON line, so ids moved out of message text stay filterable in both sinks. Nested values stay in log.args. The request context still owns requestId. The polled-webhook processor logs through a logger bound to the webhook id, so lines from concurrent polls in one tick stay distinguishable. Test expectations follow the new metadata shape.
…in log-message-tag The cheap pre-filter now admits a module whose only request id is reqId, and a let binding reassigned before it is logged is no longer followed to its initializer.
waleedlatif1
force-pushed
the
improvement/log-correlation-fields
branch
from
November 6, 2026 02:01
2c48f83 to
5c9823b
Compare
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
logger.info([${requestId}] Started)becomeslogger.info('Started', { requestId }), so a message groups across requests and lines filter byrequestId(ordocumentId,label, …) as a field. 1,937 tagged calls across 294 files moved by an AST codemod; the remaining forms (compound[${label}/phase]tags, ternary and const-built messages, prefix consts, helpers such aslogFailureOnce(logger, message, …)) were moved by hand.withRouteHandler, agenerateRequestId()id is the request context's id, which the logger already stamps on every line, so those tags are dropped without a field (per CLAUDE.md). Variables that existed only for the tag are deleted.generateRequestId(), so it is the request's id; the poll routes' lock values and responserequestIdnow equal thex-request-idheader. Each webhook poll and each emitted Sim event keeps its own id, because executions use it as an idempotency key; each poll logs through a logger bound to itswebhookId.@sim/loggernow ownsrequestId: inside a request context the context's id is authoritative, so arequestIdpassed with a line or bound withwithMetadatacannot replace it (it names the request only outside a context), and anundefinedfield no longer erases a field the line already carries. Before, an explicit field could detach a line from its request: a replay key, a resumed run's original id, or an absent optional id replaced or deleted it. The JSON line now matches the OpenTelemetry export, which already tookrequestIdfrom the context. v2 chat logs its Mothership request id assimRequestId, and ids that defaulted to'unknown'default togenerateRequestId().check:source-conventionsgainslog-message-tag: it flags a@sim/loggermessage that opens with an interpolated tag (also after static tags like[Cascade]) or interpolates a request id anywhere. It covers everyapps/*andpackages/*module that imports@sim/logger, sees optional calls, computed levels andwithMetadata-derived loggers, follows a message through concatenation, ternaries, function-scopedconst/letbindings,log*helpers and.call(logger, …), and starts at zero, so the pattern cannot come back. Bracketed lists mid-message (columns [${ids.join(', ')}]) are allowed.Type of Change
Testing
check:source-conventionspasses withlog-message-tag 0; rule tests cover each flagged form and the allowed ones (42 pass).requestId, a per-line id applies outside a context, and anundefinedfield erases nothing; the two guard tests fail on the previous logger.Checklist
test-auditauthoring gate)