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

fix(log): reduce auto balancing logging noise for detached volumes #3558

Merged
merged 1 commit into from
Feb 14, 2025

Conversation

dihmandrake
Copy link
Contributor

@dihmandrake dihmandrake commented Feb 11, 2025

Which issue(s) this PR fixes:

Issue longhorn/longhorn#10302

What this PR does / why we need it:

Reduce auto balancing logging noise for detached volumes. This might also be confusing and prompt people to investigate these messages are errors (they are warning) - at least I did

Special notes for your reviewer:

Additional documentation or context

Copy link

coderabbitai bot commented Feb 11, 2025

Walkthrough

This pull request updates the logging behavior in the volume controller during the auto-balance process for volume replicas. An additional condition checks if the volume state is not detached before logging a warning when auto-balancing fails. This change prevents excessive logging for detached volumes and provides detailed messages that include both the robustness and state of the volume without modifying the core functionality.

Changes

Files Change Summary
controller/volume_controller.go Modified logging in the auto-balance process to include a condition that checks the volume state, preventing log entries for detached volumes.

Sequence Diagram(s)

sequenceDiagram
    participant VC as VolumeController
    participant V as VolumeState
    participant L as Logger

    VC->>V: Retrieve volume state during auto-balance
    alt Volume state is active
        VC->>L: Log warning including robustness and state details
    else Volume state is detached
        VC->>L: Skip logging warning
    end
Loading

Possibly related PRs

Suggested reviewers

  • innobead

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 51b2097 and d6c9149.

📒 Files selected for processing (1)
  • controller/volume_controller.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • controller/volume_controller.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Summary

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.

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.

@dihmandrake dihmandrake force-pushed the log-noise branch 3 times, most recently from fa701b8 to 867bf02 Compare February 11, 2025 17:31
@dihmandrake dihmandrake changed the title Reduce auto balancing logging noise for detachted volumes fix(log): reduce auto balancing logging noise for detached volumes Feb 11, 2025
@dihmandrake dihmandrake removed their assignment Feb 13, 2025
@derekbit derekbit requested a review from c3y1huang February 14, 2025 00:44
See: longhorn/longhorn#10302
Signed-off-by: Jasper Bernhardt <jasper.bernhardt@gmail.com>
@derekbit
Copy link
Member

cc @c3y1huang

@mergify mergify bot merged commit 5f9ec86 into longhorn:master Feb 14, 2025
9 of 10 checks passed
@derekbit
Copy link
Member

@mergify backport v1.8.x

Copy link

mergify bot commented Feb 14, 2025

backport v1.8.x

✅ Backports have been created

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.

3 participants