Skip to content

fix(disk): Enhance partition filtering to include ZFS filesystems #64

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 1 commit into from
May 6, 2025

Conversation

mertssmnoglu
Copy link
Member

@mertssmnoglu mertssmnoglu commented May 6, 2025

Issue: #55

Updated the filtering logic to include ZFS filesystems, which are not prefixed with /dev, while continuing to exclude /dev/loop devices. This improves support for ZFS-based systems and refines the partition selection process.

How to test

shell:bash

truncate -s 100M zfs.img
LOOP=$(losetup -f --show zfs.img)

zpool create mypool "${LOOP}"
zfs create mypool/myfs
touch /mypool/myfs/hello.txt

Your df -h output will be like that

....
mypool           40M  128K   40M   1% /mypool
mypool/myfs      40M  128K   40M   1% /mypool/myfs

Run the capture and go to http://localhost:59232/api/v1/metrics/disk endpoint. It will show the mypool and mypool/myfs

If everything is ok, you can delete the pool and loop device

zpool export mypool
losetup -d "${LOOP}"

Summary by CodeRabbit

  • Bug Fixes
    • Improved disk metrics collection by including ZFS filesystems and refining partition filtering, ensuring more accurate and comprehensive disk monitoring.

@mertssmnoglu mertssmnoglu self-assigned this May 6, 2025
@mertssmnoglu mertssmnoglu added the platform:linux Linux Platforms label May 6, 2025
Copy link
Contributor

coderabbitai bot commented May 6, 2025

Walkthrough

The disk partition filtering logic in the metric collection function was updated to include ZFS filesystems. The new logic continues to exclude duplicate and loop devices but now allows partitions with a filesystem type of "zfs" even if their device names do not start with "/dev".

Changes

File(s) Change Summary
internal/metric/disk.go Updated partition filtering in CollectDiskMetrics to include ZFS filesystems in metric collection logic.

Poem

A disk hopped by, its name not found,
Unless it wore a "/dev" crown.
But now, with ZFS in the mix,
Our metrics catch more clever tricks.
No loops allowed, but ZFS can stay—
The warren’s data grows each day! 🐇

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@mertssmnoglu mertssmnoglu linked an issue May 6, 2025 that may be closed by this pull request
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: 0

🧹 Nitpick comments (1)
internal/metric/disk.go (1)

43-48: Well implemented ZFS filesystem inclusion logic.

The updated filtering logic correctly addresses the PR objective by including ZFS filesystems in the disk metrics collection. The solution maintains the existing filtering criteria while intelligently identifying ZFS partitions that wouldn't have been captured previously.

The added comments clearly explain the rationale behind the changes, making the code more maintainable.

While the implementation is correct, consider restructuring the conditional logic for better readability:

- if slices.Contains(checkedSlice, p.Device) ||
-    (strings.Contains(p.Device, "/dev/loop") || (!strings.HasPrefix(p.Device, "/dev") && p.Fstype != "zfs")) {
-    continue
- }

+ // Skip if already processed
+ if slices.Contains(checkedSlice, p.Device) {
+     continue
+ }
+ 
+ // Skip loop devices
+ if strings.Contains(p.Device, "/dev/loop") {
+     continue
+ }
+ 
+ // Skip non-/dev devices unless they are ZFS filesystems
+ if !strings.HasPrefix(p.Device, "/dev") && p.Fstype != "zfs" {
+     continue
+ }

This approach makes each condition clearer and easier to maintain, while maintaining the exact same behavior.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fd553ff and 34b7093.

📒 Files selected for processing (1)
  • internal/metric/disk.go (1 hunks)

@mertssmnoglu mertssmnoglu merged commit 994e4b3 into develop May 6, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
platform:linux Linux Platforms
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant