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(log): don't emit "Failed to auto-balance volume in ..." for detached volumes #3589

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

derekbit
Copy link
Member

Which issue(s) this PR fixes:

Issue longhorn/longhorn#10302

What this PR does / why we need it:

Special notes for your reviewer:

Additional documentation or context

@derekbit derekbit requested a review from c3y1huang February 18, 2025 09:27
@derekbit derekbit self-assigned this Feb 18, 2025
Copy link

coderabbitai bot commented Feb 18, 2025

Walkthrough

This change refines the error handling logic in the volume controller. In the getReplicaCountForAutoBalanceLeastEffort method, an added check ensures that a warning is logged only if the volume is not in the Detached state. Additionally, the getReplicaCountForAutoBalanceBestEffort method now conditions the log entry on the volume's robustness status. No exported or public entity declarations were altered.

Changes

File Path Change Summary
controller/volume_controller.go - Refined error handling in getReplicaCountForAutoBalanceLeastEffort by adding a check to prevent logging when volume is Detached.
- Adjusted logging in getReplicaCountForAutoBalanceBestEffort to condition error logs on the volume's robustness status.

Possibly related PRs

Suggested reviewers

  • c3y1huang
  • mantissahz
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@derekbit derekbit changed the title feat(log): don't emit "ailed to auto-balance volume in ..." for detached volumes feat(log): don't emit "Failed to auto-balance volume in ..." for detached volumes Feb 18, 2025
…ched volumes

Longhorn 10302

Signed-off-by: Derek Su <derek.su@suse.com>
Copy link

@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: 0

🧹 Nitpick comments (2)
controller/volume_controller.go (2)

2397-2401: Avoid unnecessary warning logs for detached volumes

The warning message about failing to auto-balance volume is logged even for detached volumes, which can cause log spam.

-		if v.Status.State != longhorn.VolumeStateDetached {
-			log.Warnf("Failed to auto-balance volume in %s state", v.Status.Robustness)
-		}
+		if v.Status.State != longhorn.VolumeStateDetached && v.Status.State != longhorn.VolumeStateDetaching {
+			log.Warnf("Failed to auto-balance volume in %s robustness and %s state", v.Status.Robustness, v.Status.State)
+		}

4996-5003: Improve error handling for V2 data engine setting

The error handling for the V2 data engine setting could be improved. Currently, it silently defaults to false when there's an error getting the setting.

 		V2DataEngineFastReplicaRebuilding, err := c.ds.GetSettingAsBool(types.SettingNameV2DataEngineFastReplicaRebuilding)
 		if err != nil {
-			log.WithError(err).Warnf("Failed to get the setting %v, will consider it as false", types.SettingDefinitionV2DataEngineFastReplicaRebuilding)
-			V2DataEngineFastReplicaRebuilding = false
+			return false, errors.Wrapf(err, "failed to get the setting %v", types.SettingDefinitionV2DataEngineFastReplicaRebuilding)
 		}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 457c62b and af83a2b.

📒 Files selected for processing (1)
  • controller/volume_controller.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build binaries
  • GitHub Check: Summary
🔇 Additional comments (1)
controller/volume_controller.go (1)

4473-4500: LGTM! Well-structured function for checking replica availability

The function has comprehensive checks for replica availability including node status and disk readiness, with proper error handling.

@derekbit derekbit merged commit 032cdaa into longhorn:master Feb 18, 2025
9 checks passed
@derekbit
Copy link
Member Author

@mergify backport v1.8.x

Copy link

mergify bot commented Feb 18, 2025

backport v1.8.x

✅ Backports have been created

@@ -2395,7 +2395,9 @@ func (c *VolumeController) getReplicaCountForAutoBalanceLeastEffort(v *longhorn.
}

if v.Status.Robustness != longhorn.VolumeRobustnessHealthy {
log.Warnf("Failed to auto-balance volume in %s state", v.Status.Robustness)
if v.Status.State != longhorn.VolumeStateDetached {
Copy link
Member

Choose a reason for hiding this comment

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

This is good to prevent any confusion.

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