feat: collect filters metrics for scanners

[evenyag]

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

This PR adds ReaderFilterMetrics and collects the metrics for SeqScan and UnorderedScan.

It also observes read row counts for scanners and compaction.

Checklist

• I have written the necessary rustdoc comments.
• I have added the necessary unit tests and integration tests.
• This PR requires documentation updates.

Summary by CodeRabbit

• New Features

  • Enhanced metrics tracking capabilities for the data scanning and reading processes, allowing for better performance monitoring.
  • Introduced a new compaction mode for the scanning process, improving functionality and versatility.

• Bug Fixes

  • Improved organization and categorization of filtering metrics, ensuring consistency and clarity in metric retrieval.

• Documentation

  • Updated method signatures and descriptions to reflect new functionality related to metrics collection and compaction mode.

[coderabbitai]

Important

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes enhance the functionality of the scanning and reading processes within the project, focusing on improved metrics collection and management. Key updates include the introduction of a compaction mode for scanning, refined metric structures for better organization, and enhancements to the handling of filtering metrics. These modifications aim to provide more insightful performance data, making the system more robust and efficient during data operations.

Changes

Files	Change Summary
src/mito2/src/compaction.rs	Added with_compaction() to SeqScan, integrating compaction logic into the reading process to enhance data handling.
src/mito2/src/read.rs, src/mito2/src/read/prune.rs	Updated ScannerMetrics to include filter_metrics for detailed tracking of filter performance, improving metrics collection.
src/mito2/src/read/scan_region.rs	Changed prune_file_ranges to return ReaderMetrics, allowing for detailed metrics collection during the file pruning operation.
src/mito2/src/read/seq_scan.rs	Introduced a compaction field in SeqScan, updated methods to accept compaction parameters, and improved metrics reporting based on operation type.
src/mito2/src/read/unordered_scan.rs	Enhanced metric tracking in UnorderedScan by updating how pruning metrics are collected and reported.
src/mito2/src/sst/parquet/reader.rs	Enhanced ParquetReaderBuilder to include ReaderMetrics for metrics collection during reading, introduced ReaderFilterMetrics for detailed filtering metrics tracking.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SeqScan
    participant ReaderMetrics

    User->>SeqScan: Start scan
    SeqScan->>SeqScan: with_compaction()
    SeqScan->>ReaderMetrics: Initialize metrics
    SeqScan->>SeqScan: Perform scan
    SeqScan->>ReaderMetrics: Collect metrics
    ReaderMetrics-->>SeqScan: Return metrics
    SeqScan-->>User: Complete scan with metrics

Loading

🐰 In the meadow, hops a rabbit bright,
Metrics gathered, oh what a sight!
With compaction and filters refined,
Data flows smoothly, perfectly aligned.
Hooray for changes, we cheer with glee,
A world of insights, for all to see! 🥕

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

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.

[evenyag]

@coderabbitai summary

[coderabbitai]

Actions performed

Summary regeneration triggered.

[codecov]

Codecov Report

Attention: Patch coverage is 94.49541% with 6 lines in your changes missing coverage. Please review.

Project coverage is 84.64%. Comparing base (975b8c6) to head (9ae28ae).
Report is 13 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4591      +/-   ##
==========================================
- Coverage   84.90%   84.64%   -0.26%     
==========================================
  Files        1096     1096              
  Lines      196635   196655      +20     
==========================================
- Hits       166949   166464     -485     
- Misses      29686    30191     +505     

[fengjiachun]

LGTM