GreptimeTeam / greptimedb

An open-source, cloud-native, distributed time-series database with PromQL/SQL/Python supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
3.96k stars 282 forks source link

feat: introduce `FlownodePeerCache` #4254

Closed WenyXu closed 1 day ago

WenyXu commented 2 days ago

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?

  1. Add get_flownode method in ClusterInfo trait.
  2. Implement the FlownodePeerCache
  3. Broadcast cache invalidation message when a new flownode is registered
  4. Add the Option<FlownodePeerCache> to Inserter

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 days ago

Walkthrough

The changes introduced a new module cluster with caching functionalities for FlownodeId to Peer mappings. This involves creating a FlownodePeerCache and associated utilities for cache management and invalidation. Modifications span multiple files to integrate this new cache, updating error handling, and enhancing the Meta client and server components to support the new capabilities.

Changes

Files Change Summary
src/.../cache.rs Added a new cluster module and exposed caching entities publicly.
src/.../cache/cluster.rs Introduced a flownode module and exported FlownodePeerCache and associated functions.
src/.../cache/cluster/flownode.rs Defined FlownodePeerCache and related functions for cache management and invalidation.
src/.../cache_invalidator.rs Added handling for CacheIdent::FlownodeId(_) indicating no caching in the KvBackend.
src/.../cluster.rs Introduced methods to handle FlownodeId, adjusted error handling, and updated list_nodes return type.
src/.../error.rs Modified error variants and handling to support new GetClusterInfo error.
src/.../instruction.rs Added FlownodeId variant to CacheIdent enum.
src/frontend/src/instance/builder.rs Added flownode_peer_cache initialization in FrontendBuilder.
src/meta-client/src/client.rs Modified list_nodes to return a boxed error and added new get_flownode async function.
src/meta-srv/src/metasrv.rs Introduced cache_invalidator field and method in the Metasrv struct.
src/meta-srv/src/metasrv/builder.rs Modified the initialization process to clone and add cache_invalidator.
src/meta-srv/src/service/heartbeat.rs Updated register_pusher function for cache invalidation handling specific roles like Flownode.
src/operator/src/insert.rs Added FlownodePeerCacheRef to Inserter with corresponding constructor modifications.
src/cache/src/lib.rs Renamed and added functions and constants related to FlownodePeerCache and customized cache registry building.
src/cmd/src/frontend.rs Updated cache registry initialization to include new cache building logic with build_fundamental_cache_registry_with.
src/frontend/src/instance.rs Added enable_access_cluster_info() method to MetaClientBuilder configuration in Instance struct implementation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MetaSrv
    participant Cache
    participant ClusterInfo

    Client->>MetaSrv: Request Peer Info for FlownodeId
    MetaSrv->>Cache: Check FlownodePeerCache
    Cache-->>MetaSrv: Cache Miss
    MetaSrv->>ClusterInfo: Retrieve Flownode Peer Info
    ClusterInfo-->>MetaSrv: Returned Peer Info
    MetaSrv->>Cache: Update FlownodePeerCache
    Cache-->>MetaSrv: Cache Updated
    MetaSrv-->>Client: Return Peer Info

Poem

In the codebase, deep and wise,
A cache for flows now does arise,
With peers and nodes, it keeps in line,
Ensuring access, every time.
Hopping through functions, swift and clear,
Our data's home, forever near.
🐇💻✨

[!TIP]

AI model upgrade ## `gpt-4o` model for reviews and chat is now live OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide any feedback or to report any issues.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 days ago

Codecov Report

Attention: Patch coverage is 54.54545% with 80 lines in your changes missing coverage. Please review.

Project coverage is 84.66%. Comparing base (ef5d1a6) to head (612ca28). Report is 5 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4254 +/- ## ========================================== - Coverage 84.96% 84.66% -0.31% ========================================== Files 1054 1055 +1 Lines 186950 187313 +363 ========================================== - Hits 158850 158591 -259 - Misses 28100 28722 +622 ```
fengjiachun commented 1 day ago

Sorry for the late review., we cannot use cluster info for routing since it is unreliable to query peers by id from cluster info. I think we need something like the TableRoute https://github.com/GreptimeTeam/greptimedb/blob/efd3f04b7cebce642578cade12d6d6e8445bc358/src/common/meta/src/key/table_route.rs#L42