pika icon indicating copy to clipboard operation
pika copied to clipboard

feat: add consistency_check tool

Open pro-spild opened this issue 9 months ago • 1 comments

使用方法为先执行写入操作,再执行读取操作,最后执行一致性检查操作。两次操作的k-v参数必须完全一致,随机种子也必须一致。 使用场景为检测主从同步一致性,以及重启/升级前后数据一致性。 检测原理为先写入数据,从主从节点分别读取数据,最后比较两次读取的数据是否一致。或者比较生成的写数据和读取的数据是否一致。

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive tool to verify data consistency across database nodes with multiple operational modes, including write operations and post-upgrade validations.
    • Enabled concurrent execution for consistency checks with configurable parameters and detailed logging.
  • Documentation

    • Added extensive usage instructions and examples in Chinese to guide users in setting up and running the consistency checks effectively.

pro-spild avatar Feb 28 '25 03:02 pro-spild

Walkthrough

This pull request introduces a new consistency check tool designed for Redis environments. New documentation, Go source files, and shell scripts have been added. The changes include detailed usage instructions, command mapping for read/write operations, helper functions for command generation, and the core logic for checking consistency across master and slave nodes. Additionally, a Go module file has been included to manage dependencies, and shell scripts facilitate concurrent execution of write and consistency-check operations.

Changes

File(s) Change Summary
tools/.../README_CN.md Added documentation detailing usage, compilation, supported parameters, operational modes, and example commands for the consistency check tool.
tools/.../{commands.go, common.go, consistency.go} Introduced core tool logic including command mappings, helper functions for generating and transforming command strings, and a complete consistency check mechanism with flag parsing, client management, concurrent execution, and result comparison.
tools/.../{consistencyCheck.sh, write.sh} Added shell scripts to execute the tool in different modes concurrently with specific parameters and logging for various operations.
tools/.../go.mod Created a Go module file specifying the module name, Go version, and managing direct and indirect dependencies for the project.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Main
    participant RedisMaster
    participant RedisSlave
    participant CmdGen
    participant Updater

    User->>Main: Run consistency_check_tool
    Main->>Main: Parse flags & setup Redis clients
    Main->>RedisMaster: Connect to master node
    Main->>RedisSlave: Connect to slave nodes
    Main->>CmdGen: Generate command set
    CmdGen-->>Main: Return commands
    Main->>RedisMaster: Execute write/read commands (sendCmd)
    RedisMaster-->>Main: Return results
    Main->>RedisSlave: Execute consistency check
    RedisSlave-->>Main: Return results
    Main->>Updater: Update CLI with stats & logs
    Updater-->>User: Display output

Poem

Hoppity-hop, I bounce with cheer,
Codes and scripts now crystal clear.
Carrots of commands lined in a row,
Consistency blooms and starts to grow.
I nibble on changes, light and free,
A jazzy dance in our code garden—yee!

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this 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.

coderabbitai[bot] avatar Feb 28 '25 03:02 coderabbitai[bot]