feat(log_store): introduce the CollectionTask

[WenyXu]

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

#4385

What's changed and what's your intention?

Introduce the CollectionTask, it performs two main operations:

• Persists the WAL index to the specified path at every dump_index_interval.
• Updates the latest index ID for each WAL provider at every checkpoint_interval.

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

  • Introduced enhanced configuration options for indexing, including new parameters for index creation and intervals.
  • Added a new GlobalIndexCollector for better index management in the data node.
  • Expanded public API with new exports like default_index_file and GlobalIndexCollector.

• Bug Fixes

  • Improved error handling with more specific error messages for different operations.

• Chores

  • Updated dependency configurations to support new data handling and processing features.

[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.

---

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.

[WenyXu]

@coderabbitai summary

[coderabbitai]

Actions performed

Summary regeneration triggered.

[coderabbitai]

Walkthrough

The recent changes enhance the configuration and functionality of the data node and log store systems. Key improvements include the introduction of new indexing capabilities, modifications to error handling, and refinements in object store management. These updates promote better organization, flexibility, and performance, ultimately leading to a more robust system architecture.

Changes

Files	Change Summary
src/common/wal/src/config.rs, src/common/wal/src/config/kafka/datanode.rs	Added default values to datanode_wal_config and new indexing fields to DatanodeKafkaConfig.
src/datanode/src/datanode.rs	Enhanced DatanodeBuilder to manage global indexing with new methods and configurations.
src/datanode/src/store.rs	Refactored object store creation methods, introducing caching and retry mechanisms.
src/log-store/Cargo.toml	Added dependencies for improved data processing and storage capabilities.
src/log-store/src/error.rs	Expanded the Error enum with more specific variants for better error handling.
src/log-store/src/kafka.rs, src/log-store/src/kafka/client_manager.rs	Updated ClientManager for global index collector integration, enhancing its flexibility.
src/log-store/src/kafka/index.rs, src/log-store/src/kafka/index/collector.rs	Introduced CollectionTask for managing background index operations and improved index encoding.
src/log-store/src/kafka/index/encoder.rs	Implemented encoding for region indexes, enhancing storage efficiency.
src/log-store/src/kafka/log_store.rs	Updated KafkaLogStore to optionally use a global index collector during initialization.
src/object-store/src/lib.rs	Added Access type to enhance object store's access control features.

Sequence Diagram(s)

sequenceDiagram
    participant ClientManager
    participant KafkaLogStore
    participant GlobalIndexCollector
    participant DatanodeBuilder

    ClientManager->>KafkaLogStore: try_new(config, global_index_collector)
    KafkaLogStore->>GlobalIndexCollector: Initialize with optional collector
    KafkaLogStore->>DatanodeBuilder: Build with indexing config
    DatanodeBuilder->>GlobalIndexCollector: Manage indexing operations

Loading

🐰 "In the meadow, changes bloom,
New indexes and structures to assume.
With each hop, we refine our space,
Enhancing the log store's pace.
A dance of code, swift and bright,
In the rabbit’s burrow, all feels right!" 🐇

---

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.

[codecov]

Codecov Report

Attention: Patch coverage is 85.53846% with 47 lines in your changes missing coverage. Please review.

Project coverage is 84.63%. Comparing base (c8de8b8) to head (23aa13f).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4530      +/-   ##
==========================================
- Coverage   84.88%   84.63%   -0.25%     
==========================================
  Files        1094     1096       +2     
  Lines      196364   196628     +264     
==========================================
- Hits       166674   166410     -264     
- Misses      29690    30218     +528     

[WenyXu]

@fengjiachun @v0y4g3r PTAL

[fengjiachun]

@WenyXu CI failed

[v0y4g3r]

LGTM