Skip to content

Add v4 timeline metrics to prod runs #1884

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.

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

Merged
merged 9 commits into from
Apr 4, 2025
Merged

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Apr 4, 2025

Also fixes worker names on create and adds more debug logs on errors.

Summary by CodeRabbit

  • New Features

    • Added enhanced timing and metrics for task processing, resulting in improved monitoring of task scheduling and execution.
    • Updated event permissions so that import events are now accessible by non-admin users.
    • Improved task cancellation handling in the CLI for a more reliable user experience.
    • Introduced new environment variables to provide timing information for workload management in Docker and Kubernetes.
  • Bug Fixes

    • Enhanced error handling and logging during task execution and cancellation processes.

Copy link

changeset-bot bot commented Apr 4, 2025

⚠️ No Changeset found

Latest commit: 8fd8c4b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Apr 4, 2025

Walkthrough

This pull request enhances task workload tracking by introducing a new dequeuedAt timestamp. The property is added in the supervisor’s message handler and propagated to the workload manager across both Docker and Kubernetes configurations via new environment variables. The associated type definitions are updated accordingly. Additional changes adjust the admin filtering logic for the "import" event in the webapp and skip a related test. Improvements to error handling and metrics tracking are made in the CLI run controllers, including the use of a SIGKILL signal when needed.

Changes

File(s) Change Summary
apps/supervisor/src/index.ts Added dequeuedAt property in the runQueueMessage event handler, passing it to the workload manager.
apps/supervisor/src/workloadManager/docker.ts, apps/supervisor/src/workloadManager/kubernetes.ts Introduced new environment variables TRIGGER_DEQUEUED_AT_MS and TRIGGER_POD_SCHEDULED_AT_MS; modified the worker instance name retrieval in Kubernetes.
apps/supervisor/src/workloadManager/types.ts Added dequeuedAt: Date property to the WorkloadManagerCreateOptions interface.
apps/webapp/app/utils/timelineSpanEvents.ts, apps/webapp/test/timelineSpanEvents.test.ts Changed the "import" event's admin filtering logic (returns false instead of true) and skipped an associated test case.
packages/cli-v3/src/entryPoints/dev-run-controller.ts Enhanced error handling during task run cancellation by adding a SIGKILL attempt and removing outdated comments.
packages/cli-v3/src/entryPoints/managed-run-controller.ts Updated method signatures to include optional dequeuedAt and podScheduledAt parameters; improved metrics tracking and debug logging.

Sequence Diagram(s)

sequenceDiagram
    participant S as Supervisor
    participant WM as WorkloadManager
    participant C as Container (Docker/K8s)
    
    S->>WM: Receive runQueueMessage (with dequeuedAt)
    WM->>C: create container with env vars\n(TRIGGER_DEQUEUED_AT_MS & TRIGGER_POD_SCHEDULED_AT_MS)
    note over C: Container initialized with timing metadata
Loading
sequenceDiagram
    participant DR as DevRunController
    participant Process as Task Run Process
    participant MR as ManagedRunController
    
    DR->>Process: Attempt cancellation of task run
    alt Cancellation fails
        DR->>Process: Send SIGKILL signal
        Process-->>DR: Log failure if SIGKILL fails
    end
    MR->>MR: startAndExecuteRunAttempt(dequeuedAt, podScheduledAt)
    MR->>MR: executeRun with collected metrics
Loading

Possibly related PRs

Suggested reviewers

  • ericallam

Poem

I'm a rabbit with a cheerful hop,
Timing blooms in code non-stop.
dequeuedAt leads the lively parade,
Docker and K8s join the upgrade.
Errors chased with a SIGKILL, oh so neat,
Hopping to code with a victorious beat.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf13523 and 8fd8c4b.

📒 Files selected for processing (1)
  • apps/webapp/test/timelineSpanEvents.test.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/webapp/test/timelineSpanEvents.test.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@nicktrn nicktrn marked this pull request as ready for review April 4, 2025 15:51
@nicktrn nicktrn merged commit 58567bf into main Apr 4, 2025
12 checks passed
@nicktrn nicktrn deleted the feat/v4-deploy-startup-metrics branch April 4, 2025 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants