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

Improve ranking error output #3763

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Improve ranking error output #3763

merged 1 commit into from
Apr 8, 2024

Conversation

simonwo
Copy link
Contributor

@simonwo simonwo commented Apr 8, 2024

This is a commit that was included in #3756 and seemed uncontroversial. It didn't actually make any use of the structured error output, and just improves the node ranking error mesages by:

  • Shows the number of nodes that were available even if unsuitable, because users often misinterpret "0 available" as meaning there is a connection error between nodes in the network
  • Summarises nodes when they all print the same output rather than listing all of them

As an example, failures to rank now look like:

% bin/darwin/arm64/bacalhau job run testdata/jobs/docker.yaml
Job successfully submitted. Job ID: j-2baef550-3023-4211-822d-eb2c88c4dfe1
Checking job status... (Enter Ctrl+C to exit at any time, your job will continue running):

	Communicating with the network  ................  done ✅  0.0s
	   Creating job for submission  ................  err  ❌  0.5s

Error submitting job: not enough nodes to run job. requested: 1, available: 4, suitable: 0.
• 4 of 4 nodes: job requires more memory (200 GB) than the maximum available (14 GB)

To get more details about the run, execute:
	bacalhau job describe j-2baef550-3023-4211-822d-eb2c88c4dfe1

To get more details about the run executions, execute:
	bacalhau job executions j-2baef550-3023-4211-822d-eb2c88c4dfe1

- Show the number of nodes that were available even if unsuitable,
  because users often misinterpret "0 available" as meaning there is a
  connection error
- Summarise nodes when they all print the same output rather than
  listing all of them
@simonwo simonwo requested review from wdbaruni and a team April 8, 2024 07:41
@simonwo simonwo self-assigned this Apr 8, 2024
Copy link

coderabbitai bot commented Apr 8, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@rossjones rossjones left a comment

Choose a reason for hiding this comment

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

LGTM!

@simonwo simonwo enabled auto-merge (rebase) April 8, 2024 09:26
@simonwo simonwo merged commit c956c49 into main Apr 8, 2024
12 checks passed
@simonwo simonwo deleted the simonwo/ranking-err branch April 8, 2024 10:22
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.

None yet

2 participants