feat(log_store): introduce the IndexCollector

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

1. Separate BackgroundProducerWorker into files
2. Introduce IndexCollector to collect WAL EntryIds

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 a modular indexing and collection system for managing log entries.
  • Enhanced error handling with clearer state messages for the Kafka producer.
  • Updated the produce method to include region-specific context for better data processing.

• Bug Fixes

  • Streamlined request handling in the Kafka producer for improved efficiency and clarity.

• Documentation

  • Improved comments and structure throughout the codebase for better maintainability.

• Refactor

  • Reorganized the producer and worker components to enhance modularity and reduce complexity.

• Chores

  • Added new dependencies to improve byte handling capabilities.

[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 changes introduce a comprehensive restructuring of the Kafka log storage system, enhancing index management and producer functionality. New traits and structures improve modularity, while error handling has been simplified. The implementation of background workers allows for asynchronous processing of produce requests, ensuring efficient data handling. Overall, these updates aim to bolster performance, maintainability, and clarity within the logging infrastructure.

Changes

Files	Change Summary
collector.rs, kafka/index.rs, kafka/index/collector.rs	Introduced index management structures and traits, including GlobalIndexCollector and IndexCollector, enhancing modularity and organization.
Cargo.toml	Added bytes crate dependency for efficient byte handling.
error.rs, kafka/client_manager.rs	Modified error handling for OrderedBatchProducer, replacing existing variants for clarity. Updated ClientManager to integrate a global index collector.
kafka/log_store.rs, kafka/producer.rs, kafka/worker/produce.rs	Updated produce method signatures to include region_id, improving context awareness in record handling. Simplified request structures and logic for better efficiency.
kafka/worker.rs, kafka/worker/checkpoint.rs, kafka/worker/flush.rs, kafka/worker/produce.rs	Introduced BackgroundProducerWorker for handling asynchronous Kafka requests, with methods for flushing and checkpointing to enhance performance.

Sequence Diagram(s)

sequenceDiagram
    participant ClientManager
    participant BackgroundProducerWorker
    participant GlobalIndexCollector
    participant KafkaProvider

    ClientManager->>BackgroundProducerWorker: Create producer with region_id
    BackgroundProducerWorker->>GlobalIndexCollector: Use global index collector
    BackgroundProducerWorker->>KafkaProvider: Produce records
    KafkaProvider-->>BackgroundProducerWorker: Confirmation
    BackgroundProducerWorker->>GlobalIndexCollector: Update index with produced results

Loading

🐇 In the land of logging, hops and jumps,
New indexes collect with joyful thumps!
Producers now dance with regions in sight,
As asynchronous magic makes everything right!
With bytes and structure, we frolic and play,
A logging adventure, hip-hip-hooray! 🌟

---

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 76.16099% with 77 lines in your changes missing coverage. Please review.

Project coverage is 84.67%. Comparing base (8037800) to head (aff9770).
Report is 23 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4461      +/-   ##
==========================================
- Coverage   85.01%   84.67%   -0.34%     
==========================================
  Files        1084     1090       +6     
  Lines      193863   194321     +458     
==========================================
- Hits       164806   164543     -263     
- Misses      29057    29778     +721     

[WenyXu]

@coderabbitai summary

[coderabbitai]

Actions performed

Summary regeneration triggered.

[WenyXu]

@fengjiachun @v0y4g3r PTAL

[fengjiachun]

LGTM

[v0y4g3r]

LGTM