Feat/improved logging

[TheodoreSpeaks]

Summary

We need additional observability into our system, even for successful calls.
Add additional logs for the /execute endpoint with metadata for user id, workflow id, workspace id, execution id. Reverted change to upgrade mothership chat logs to error.

I upgraded our logging system to INFO, so all logs should start showing up.

New formatting:

  [2026-03-28T14:32:01.500Z] [DEBUG] [ExecutionLogger] {workflowId=wf-9f3e workspaceId=ws-7720 executionId=exec-88f2} Starting workflow
   execution
  [2026-03-28T14:32:01.512Z] [DEBUG] [ExecutionLogger] {workflowId=wf-9f3e workspaceId=ws-7720 executionId=exec-88f2} Created workflow
  log {"logId":"log-ab12"}
  [2026-03-28T14:32:02.200Z] [DEBUG] [ExecutionLogger] {executionId=exec-88f2} Completing workflow execution {"isResume":false}
  [2026-03-28T14:32:02.350Z] [ERROR] [ExecutionLogger] {workflowId=wf-9f3e executionId=exec-88f2} Workflow not found for user stats
  update

Type of Change

• Bug fix
• New feature
• Breaking change
• Documentation
• Other: ___________

Testing

Ran workflow execution and validated new metadata logs are shown

Checklist

• Code follows project style guidelines
• Self-reviewed my changes
• Tests added/updated and passing
• No new warnings introduced
• I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Screenshots/Videos

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
docs	Skipped		Mar 30, 2026 9:58pm

[TheodoreSpeaks]

@greptile review

[TheodoreSpeaks]

@BugBot review

[cursor]

PR Summary

Low Risk
Primarily refactors logging (levels and structured metadata) across request handlers and executor paths; functional behavior is largely unchanged aside from when/where some IDs are generated for logging context.

Overview
Improves observability by standardizing structured logging across Copilot chat APIs, Mothership endpoints, and workflow execution.

Replaces appendCopilotLogContext(...) string concatenation with logger.withMetadata(...) and generally shifts many success-path logs from error to info/warn, while preserving error logging for actual failures.

Adds consistent request-scoped metadata (requestId, messageId, and for workflow execution also workflowId, workspaceId, userId, executionId) throughout /workflows/[id]/execute, the executor (DAGExecutor, ExecutionEngine, BlockExecutor), and streaming/orchestrator code; updates affected tests to mock withMetadata.

^{Written by Cursor Bugbot for commit bb5702a. This will update automatically on new commits. Configure here.}

[cursor]

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

[greptile-apps]

Greptile Summary

Adds withMetadata() to the Logger class so structured context is automatically included in log lines. Applied across the execute route, executor classes, ExecutionLogger, and copilot tooling routes — replacing the old appendCopilotLogContext helper and fixing many logger.error() calls used for routine informational events.

Notable changes:

• Logger package: withMetadata(metadata) returns an immutable child logger with merged key-value pairs. Full unit tests added.
• Executor classes gain an execLogger field initialised from execution context in each constructor.
• Execute route builds up reqLogger progressively, replacing [requestId] string interpolation.
• ExecutionLogger uses metadata-bound loggers throughout, addressing a prior review comment.
• Minor: two logger.warn() calls in generate-visualization.ts and one logger.error() in user-table.ts still use the bare module logger instead of the local reqLogger, losing messageId context on those lines.

Confidence Score: 5/5

• Safe to merge — no logic errors or data correctness issues; only minor style inconsistencies remain.
• All findings are P2: two log calls in generate-visualization.ts and one in user-table.ts use the bare module logger instead of the enriched reqLogger, losing messageId context on those lines. These are observability nits with no impact on correctness or runtime behaviour. The core Logger.withMetadata implementation is clean, well-tested, and correctly applied across the vast majority of the codebase.
• apps/sim/lib/copilot/tools/server/visualization/generate-visualization.ts (lines 98, 134) and apps/sim/lib/copilot/tools/server/table/user-table.ts (line 247) — bare logger used instead of local reqLogger.

Important Files Changed

Filename	Overview
packages/logger/src/index.test.ts	Comprehensive new test suite for withMetadata: covers immutability, chaining, key override, undefined-value filtering, and empty-metadata edge case.
apps/sim/lib/logs/execution/logger.ts	Replaces bare string-interpolated debug/error messages with withMetadata-bound loggers carrying workflowId, workspaceId, and executionId; addresses the prior review comment about completeExecution lacking context.
apps/sim/app/api/workflows/[id]/execute/route.ts	Introduces a reqLogger enriched progressively with requestId → workflowId → userId/executionId → workspaceId; replaces all [requestId] … string interpolation with structured metadata.
apps/sim/executor/execution/block-executor.ts	Adds execLogger instance field initialised in constructor with workflowId, workspaceId, executionId, userId, requestId; all log calls in class methods migrated to it.
apps/sim/executor/execution/engine.ts	Same pattern as block-executor: execLogger initialised in constructor from context fields; all module-level logger calls replaced.
apps/sim/executor/execution/executor.ts	Same pattern as engine.ts; execLogger initialised from contextExtensions fields.
apps/sim/lib/copilot/tools/server/visualization/generate-visualization.ts	Migrated to reqLogger but two logger.warn calls (lines 98, 134) in collectSandboxFiles were not updated, losing messageId context on those log lines.
apps/sim/lib/copilot/tools/server/table/user-table.ts	Migrated to reqLogger except the unauthorized-access error on line 247 which still uses bare logger, losing messageId context.
packages/testing/src/mocks/logger.mock.ts	Updated mock to expose withMetadata returning another mock logger, matching the real API.
apps/sim/app/api/workflows/[id]/execute/route.async.test.ts	Updated @sim/logger mock to use the factory pattern, returning a recursive mock logger with withMetadata support.

Sequence Diagram

sequenceDiagram
    participant Route as execute/route.ts
    participant Logger as Logger (module)
    participant Child1 as reqLogger {requestId, workflowId}
    participant Child2 as reqLogger {+userId, executionId}
    participant Child3 as reqLogger {+workspaceId}
    participant Executor as DAGExecutor / Engine / BlockExecutor

    Route->>Logger: withMetadata({requestId, workflowId})
    Logger-->>Child1: child logger
    Route->>Child1: info("Starting server-side execution")
    Route->>Child1: withMetadata({userId, executionId})
    Child1-->>Child2: merged child logger
    Route->>Child2: error("Workflow has no workspaceId") [if missing]
    Route->>Child2: withMetadata({workspaceId})
    Child2-->>Child3: merged child logger
    Route->>Child3: info("Preprocessing passed")
    Route->>Executor: new DAGExecutor(contextExtensions)
    Executor->>Logger: withMetadata({workflowId, workspaceId, executionId, userId, requestId})
    Logger-->>Executor: execLogger stored as field
    Executor->>Executor: execLogger.info / warn / error (all log lines carry full context)

Loading

_{Reviews (4): Last reviewed commit: "Merge branch 'staging' into feat/improve..." | Re-trigger Greptile}

[TheodoreSpeaks]

@greptile review

[TheodoreSpeaks]

@greptile review

[TheodoreSpeaks]

@BugBot review

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}