Skip to content

fix: improve consistent hashing #4512

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.

Sign up for GitHub

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

Jump to bottom
Merged
hengfeiyang merged 7 commits into from
Sep 11, 2024
Merged

fix: improve consistent hashing #4512

hengfeiyang merged 7 commits into from
Sep 11, 2024

Conversation

@hengfeiyang
Copy link
Contributor

@hengfeiyang hengfeiyang commented Sep 10, 2024 •
edited by coderabbitai bot
Loading

  • Fixed: should use hostname for consistent hashing
  • Fixed: use a bigger vnode number and a prime let the hashing more evenly
  • Added: use node status API lists consistent hashing

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced a new asynchronous function to retrieve and organize nodes by consistent hash values.
    • Enhanced the status response to include detailed statistics related to consistent hashing.

  • Bug Fixes

    • Improved error handling in the node index retrieval process, ensuring better logging for missing node names.

  • Chores

    • Updated optimization strategy for the unlock function by removing the inlining attribute.

@github-actions github-actions bot added the ☢️ Bug Something isn't working label Sep 10, 2024
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2024 •
edited
Loading

Walkthrough

The pull request introduces multiple changes across various files, including the addition of a new asynchronous function, print_consistent_hash, which organizes nodes based on consistent hash values. The cache_status function is updated to include the output of this new function. Additionally, the default value for consistent_hash_vnodes is modified, variable names are updated for clarity, and error handling in the partition_file_by_hash function is improved to log missing node names instead of defaulting to zero.

Changes

File Path Change Summary
src/common/infra/cluster/mod.rs Added pub async fn print_consistent_hash() to return a HashMap of nodes organized by consistent hash values.
src/config/src/config.rs Changed default value of consistent_hash_vnodes in pub struct Limit from 16 to 100.
src/handler/grpc/request/event.rs Renamed variable node to node_name for clarity in the Eventer implementation.
src/handler/http/request/status/mod.rs Modified pub async fn cache_status() to include the output of cluster::print_consistent_hash() in the response.
src/infrastructure/src/dist_lock.rs Removed #[inline(always)] from pub async fn unlock(locker: &Option<Locker>).
src/service/compact/flatten.rs Renamed variable node to node_name and updated comparisons to use LOCAL_NODE.name.
src/service/compact/mod.rs Renamed variable node to node_name and updated comparisons to use LOCAL_NODE.name.
src/service/search/cluster/mod.rs Enhanced error handling in partition_file_by_hash to log missing node names instead of using unwrap_or(&0).

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant HTTPHandler
    participant Cluster
    participant Stats

    Client->>HTTPHandler: Request status
    HTTPHandler->>Cluster: Call print_consistent_hash()
    Cluster-->>HTTPHandler: Return consistent hash data
    HTTPHandler->>Stats: Update stats with consistent hash
    HTTPHandler-->>Client: Return status with updated stats
Loading
Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 212c3c0 and 09cb363.

Files selected for processing (1)
  • src/common/infra/cluster/mod.rs (8 hunks)
Additional context used
Path-based instructions (1)
src/common/infra/cluster/mod.rs (1)

Pattern **/*.rs: You are a smart rustlang pull request reviewer.
You are going to review all the rustlang files.
Be concise, and add a brief explanation to your suggestions

Make sure the responses are not too verbose and keep the suggestions to the point i.e. actionable.

Additional comments not posted (5)
src/common/infra/cluster/mod.rs (5)

16-16: LGTM!

The HashMap import from the collections module is necessary for the new print_consistent_hash function.

42-42: LGTM!

The new constant CONSISTENT_HASH_PRIME is used to enhance the key formatting and can help improve the distribution of the hashing.

121-156: LGTM!

The new print_consistent_hash function is implemented correctly. It provides a way to list the consistent hashing information by organizing nodes based on their consistent hash values from several sources.

Line range hint 591-644: LGTM!

The test case changes reflect the updates made to the consistent hashing logic, such as the changes in node naming. The additional test keys help ensure that the functions behave as expected.

67-69: LGTM!

The logic changes to use node.name instead of node.uuid for generating keys in the add_node_to_consistent_hash and remove_node_from_consistent_hash functions are consistent with the updates made to the test cases. The use of CONSISTENT_HASH_PRIME can help improve the distribution of the hashing.

Also applies to: 86-88

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

@hengfeiyang hengfeiyang marked this pull request as draft September 10, 2024 14:20
@hengfeiyang hengfeiyang changed the title fix: debug consistent hashing fix: improve consistent hashing Sep 11, 2024
@hengfeiyang hengfeiyang marked this pull request as ready for review September 11, 2024 03:20
@hengfeiyang hengfeiyang merged commit c9ac279 into main Sep 11, 2024
@hengfeiyang hengfeiyang deleted the fix/consitent-hashing branch September 11, 2024 03:47
This was referenced Sep 13, 2024
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 21, 2024
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 22, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oasisk oasisk oasisk approved these changes

@haohuaijin haohuaijin Awaiting requested review from haohuaijin

Assignees

No one assigned

Labels

☢️ Bug Something isn't working 🧹 Updates

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hengfeiyang @oasisk