Skip to content
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

feat: improve error handling and logging in the compute package #4850

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

Conversation

virajbhartiya
Copy link
Contributor

@virajbhartiya virajbhartiya commented Feb 13, 2025

Closes #4684 #4849
This pull request includes several changes to improve error handling and logging in the compute package. The most important changes include adding error metrics, handling specific error cases, and enhancing logging to provide more detailed information.

Error Handling Improvements:

  • pkg/compute/bidder.go: Improved error handling in the handleBidResult function by checking for specific error types and logging detailed messages.

Logging Enhancements:

Metrics Addition:

  • pkg/compute/metrics.go: Added new metrics to track errors encountered during execution bidding, running, and cancellation.

Miscellaneous Changes:

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling with robust differentiation between error types during critical processes, ensuring more graceful failure management.
  • New Features

    • Introduced metrics to monitor errors across key phases, including bidding, execution, and cancellation, enhancing system insight.
  • Refactor

    • Streamlined logging and error reporting for clearer traceability and improved diagnostic capabilities during operations.

Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Warning

Rate limit exceeded

@virajbhartiya has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d522430 and 2d0e837.

📒 Files selected for processing (3)
  • pkg/compute/bidder.go (2 hunks)
  • pkg/compute/metrics.go (1 hunks)
  • pkg/compute/watchers/executor_watcher.go (2 hunks)

Walkthrough

This pull request refines the error handling across the compute package. In the bidder module, error checks now distinguish specific error types, and additional logging is implemented. In the executor watcher, errors during bidding, execution, and cancellation are handled with improved logging and corresponding metric increments. Additionally, three new error metrics are introduced in the metrics file to track execution errors more closely.

Changes

File(s) Change Summary
pkg/compute/bidder.go,
pkg/compute/watchers/executor_watcher.go
Enhanced error handling logic and logging. The bidder module now differentiates error types from state updates and captures detailed error info using a new variable. The executor watcher logs events with zerolog and increments new error metrics for different execution phases.
pkg/compute/metrics.go Added three new Int64Counter metrics—ExecutionBiddingErrors, ExecutionRunErrors, and ExecutionCancelErrors—to monitor errors encountered during bidding, running, and cancellation phases.

Sequence Diagram(s)

sequenceDiagram
    participant B as Bidder
    participant S as Store
    participant L as Logger
    B->>S: UpdateExecutionState()
    alt Error is ErrInvalidExecutionState
        B->>L: Log debug: "Skipping update owing to invalid state"
    else Other error encountered
        B->>B: Call handleError()
        Note right of B: Update execution state to failed
        B->>L: Log detailed error if failErr exists
    end
Loading
sequenceDiagram
    participant E as ExecutionUpsertHandler
    participant O as Operation
    participant M as Metrics
    participant L as Logger
    E->>O: Perform bidding/execution/cancellation
    alt Error occurs during operation
        E->>M: Increment corresponding error metric
        E->>L: Log error with execution ID & state details
    else No error
        E->>E: Continue normal flow
    end
Loading

Possibly related PRs

Poem

I'm a rabbit with a cheerful beat,
Hopping through code with nimble feet.
Errors caught and logs so clear,
Metrics tracking far and near.
With each bug hop, my joy's complete!
🐰🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@virajbhartiya
Copy link
Contributor Author

@wdbaruni Can you please take a look at this

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b7f9cd6 and d522430.

📒 Files selected for processing (3)
  • pkg/compute/bidder.go (2 hunks)
  • pkg/compute/metrics.go (1 hunks)
  • pkg/compute/watchers/executor_watcher.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: testcontainers-suite / tests
🔇 Additional comments (2)
pkg/compute/watchers/executor_watcher.go (1)

33-36: LGTM! Well-structured logging setup.

The logger is properly configured with relevant context fields that will help with debugging and tracing issues.

pkg/compute/bidder.go (1)

223-232: LGTM! Robust error type handling.

Good use of error type assertion to handle invalid state errors gracefully. The debug logging provides excellent context for troubleshooting.

pkg/compute/metrics.go Outdated Show resolved Hide resolved
pkg/compute/watchers/executor_watcher.go Outdated Show resolved Hide resolved
pkg/compute/bidder.go Outdated Show resolved Hide resolved
virajbhartiya and others added 3 commits February 13, 2025 21:09
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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.

Implement error handling when updating execution state in Bidder
1 participant