Skip to content
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.

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

feat: migrate local WAL regions #4715

Merged
merged 22 commits into from
Sep 20, 2024

Conversation

WenyXu
Copy link
Member

@WenyXu WenyXu commented Sep 10, 2024

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. Allow flushing region before migrating
  2. Skip replaying memtable for local WAL regions

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 new flush_timeout field for enhanced control over region downgrades.
    • Added is_remote_wal method to check if the provider is a remote Write-Ahead Log (WAL).
    • Implemented a new asynchronous method for gracefully setting regions to read-only.
  • Improvements

    • Increased default timeout for migration operations from 10 seconds to 30 seconds.
    • Simplified timeout parameter naming for clarity across various functionalities.
  • Bug Fixes

    • Enhanced error handling for exceeded deadlines during region downgrade operations.
  • Tests

    • Added new tests for Kafka log storage integration and timeout scenarios.

Copy link
Contributor

coderabbitai bot commented Sep 10, 2024

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 primarily involve updates to dependency versions, modifications of timeout parameters, and enhancements to error handling across various files. Notable alterations include the introduction of new fields in structs, renaming of parameters for clarity, and the addition of new methods to improve functionality. The overall focus is on refining control flow, enhancing testing capabilities, and ensuring better management of resource handling and timeout behaviors.

Changes

Files Change Summary
Cargo.toml, src/mito2/Cargo.toml Updated greptime-proto dependency version; added scopeguard dependency; marked several dependencies as workspace dependencies.
src/common/function/src/table/migrate_region.rs Renamed and updated timeout constant from DEFAULT_REPLAY_TIMEOUT_SECS to DEFAULT_TIMEOUT_SECS (10s to 30s).
src/common/meta/src/instruction.rs Added flush_timeout field to DowngradeRegion struct.
src/common/meta/src/rpc/procedure.rs Renamed replay_timeout to timeout in MigrateRegionRequest struct.
src/datanode/src/heartbeat/handler.rs Introduced downgrade_tasks field to RegionHeartbeatResponseHandler and HandlerContext.
src/datanode/src/heartbeat/handler/downgrade_region.rs Added set_readonly_gracefully async method; refactored handle_downgrade_region_instruction.
src/datanode/src/heartbeat/handler/upgrade_region.rs Simplified instantiation of HandlerContext in tests.
src/datanode/src/tests.rs Introduced MockSetReadonlyGracefullyHandler for testing; updated MockRegionEngine.
src/meta-client/src/client.rs, src/meta-client/src/client/procedure.rs Renamed replay_timeout to timeout in multiple methods.
src/meta-srv/src/error.rs Added ExceededDeadline error variant to Error enum.
src/meta-srv/src/procedure/region_migration.rs Renamed replay_timeout to timeout; added methods for operation duration tracking.
src/meta-srv/src/procedure/region_migration/downgrade_leader_region.rs Enhanced error handling in DowngradeLeaderRegion state machine; simplified method signatures.
src/meta-srv/src/procedure/region_migration/manager.rs Renamed replay_timeout to timeout in RegionMigrationProcedureTask.
src/meta-srv/src/procedure/region_migration/test_util.rs Increased replay_timeout duration in new_persistent_context function.
src/meta-srv/src/procedure/region_migration/upgrade_candidate_region.rs Removed replay_timeout; added dynamic timeout handling.
src/meta-srv/src/region/supervisor.rs Renamed replay_timeout to timeout in Task struct.
src/meta-srv/src/service/procedure.rs Renamed replay_timeout_secs to timeout_secs in ProcedureService.
src/mito2/src/engine/catchup_test.rs Enhanced tests using Kafka log store factory.
src/mito2/src/test_util.rs Added single_kafka_log_store_factory test function.
src/mito2/src/worker/handle_catchup.rs Added checks for remote WAL when replaying memtable.
src/store-api/src/logstore/provider.rs Added is_remote_wal method to Provider.

Suggested reviewers

  • WenyXu
  • MichaelScofield

🐰 In the land of code, we hop and play,
With changes made, we brighten the day.
Dependencies updated, timeouts refined,
A smoother journey for all, we find.
So let us rejoice in this code parade,
For every little change, a new path is laid! 🌟


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

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.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Sep 10, 2024
@WenyXu WenyXu marked this pull request as ready for review September 10, 2024 10:49
@WenyXu WenyXu changed the title feat: allow to flush region before migrating feat: migrate local WAL regions Sep 10, 2024
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

Attention: Patch coverage is 97.06840% with 18 lines in your changes missing coverage. Please review.

Project coverage is 84.41%. Comparing base (0c9b8eb) to head (927ff3c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4715      +/-   ##
==========================================
- Coverage   84.68%   84.41%   -0.27%     
==========================================
  Files        1118     1118              
  Lines      202399   202454      +55     
==========================================
- Hits       171393   170911     -482     
- Misses      31006    31543     +537     

@github-actions github-actions bot added docs-required This change requires docs update. and removed docs-not-required This change does not impact docs. labels Sep 10, 2024
src/common/meta/src/instruction.rs Outdated Show resolved Hide resolved
src/common/meta/src/instruction.rs Outdated Show resolved Hide resolved
src/meta-srv/src/procedure/region_migration.rs Outdated Show resolved Hide resolved
src/meta-srv/src/procedure/region_migration.rs Outdated Show resolved Hide resolved
@MichaelScofield
Copy link
Collaborator

Why allow migrating regions that use local WAL, won't it cause data loss?

@WenyXu
Copy link
Member Author

WenyXu commented Sep 19, 2024

Why allow migrating regions that use local WAL, won't it cause data loss?

Yes, But we can leave this trade off to users.

@WenyXu
Copy link
Member Author

WenyXu commented Sep 19, 2024

@coderabbitai summary

Copy link
Contributor

coderabbitai bot commented Sep 19, 2024

Actions performed

Summary regeneration triggered.

@github-actions github-actions bot added docs-not-required This change does not impact docs. and removed docs-required This change requires docs update. labels Sep 19, 2024
Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

@MichaelScofield MichaelScofield added this pull request to the merge queue Sep 20, 2024
Merged via the queue into GreptimeTeam:main with commit 163cea8 Sep 20, 2024
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants