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(snapshot-backfill): introduce state to snapshot backfill #19720

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

wenym1
Copy link
Contributor

@wenym1 wenym1 commented Dec 9, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

In this PR, we will introduce state to track the progress of snapshot backfill. The progress state table will have the following schema

| vnode | `epoch` | `row_count` | `is_epoch_finished` | pk ...
  • The pk of the state is vnode, which means we track the snapshot backfill progress in per-vnode way.
  • epoch is the epoch that the vnode is currently consuming on. We can assume that epoch >= snapshot_epoch. When epoch == snapshot_epoch, the vnode will be consuming the snapshot, and when epoch > snapshot_epoch, the vnode will be consuming the change log on epoch.
  • row_count is the number of rows that we have consumed in this epoch. The row_count is measured in per-vnode manner.
  • is_epoch_finished means whether the vnode has finished consuming the epoch.
  • pk... is the current progress of consuming the epoch. When the fields only make sense when is_epoch_finished is false. Note that the pk... is the pk of the first unconsumed row, rather than the pk of the last consumed row, which is different to the one in arrangement backfill.

With the VnodeStream implemented in #19936, we can get the current progress of each vnode before the stream is finished. When barrier is received, we can first drain the buffer, and then use Peekable::peek to get the first unconsumed row, and then save the pk to the backfill progress state.

In this PR, we only write the progress state, and only read the state for sanity check. In future PR, we will read the progress state to support recoverable snapshot backfill.

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

Copy link
Contributor Author

wenym1 commented Dec 9, 2024

@wenym1 wenym1 force-pushed the yiming/storage-table-iter-avoid-slice-clone branch from 641fa65 to a3f0881 Compare December 10, 2024 10:35
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from c2868dd to d5c4a10 Compare December 10, 2024 10:36
Base automatically changed from yiming/storage-table-iter-avoid-slice-clone to main December 11, 2024 03:46
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch 2 times, most recently from 5567d22 to ba717b7 Compare December 12, 2024 07:53
if self.streams.is_empty() {
break Poll::Ready(Ok(None));
}
for (vnode, stream) in &mut self.streams {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Will polling the streams in vnode order cause starvation or data skew in downstream? Should we use FuturesUnordered instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to use FuturesUnordered in #19936

@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from ba717b7 to 353a5c9 Compare December 25, 2024 02:56
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 353a5c9 to 45a1be4 Compare December 25, 2024 05:51
@wenym1 wenym1 changed the base branch from main to yiming/lazily-remove-uploader-instance-data December 25, 2024 05:51
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 45a1be4 to 0fb452c Compare December 25, 2024 08:16
@wenym1 wenym1 changed the base branch from yiming/lazily-remove-uploader-instance-data to yiming/snapshot-backfill-vnode-stream December 25, 2024 08:16
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-vnode-stream branch from 2d2947f to 579b264 Compare December 25, 2024 09:49
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 0fb452c to 7a48e72 Compare December 25, 2024 09:50
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-vnode-stream branch 2 times, most recently from de3fef3 to 627c55a Compare December 30, 2024 09:30
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 7a48e72 to 0913965 Compare December 30, 2024 09:30
@wenym1 wenym1 requested review from hzxa21 and kwannoel December 30, 2024 10:17
Base automatically changed from yiming/snapshot-backfill-vnode-stream to main December 30, 2024 10:53
@graphite-app graphite-app bot requested review from a team December 30, 2024 10:53
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 0913965 to 39b4c1b Compare December 30, 2024 13:10
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

license-eye has checked 5534 files.

Valid Invalid Ignored Fixed
2332 1 3201 0
Click to see the invalid file list
  • src/stream/src/executor/backfill/snapshot_backfill/state.rs
Use this command to fix any missing license headers
```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 43a6729 to b5d15ae Compare January 3, 2025 07:29
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from b5d15ae to 8ad6a3b Compare January 3, 2025 08:54
@wenym1 wenym1 changed the base branch from main to yiming/vnode-stream-row-count January 3, 2025 08:54
Base automatically changed from yiming/vnode-stream-row-count to main January 3, 2025 10:42
@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 8ad6a3b to 8b58adc Compare January 3, 2025 11:04
@wenym1
Copy link
Contributor Author

wenym1 commented Jan 6, 2025

The PR is ready for review now. PTAL @hzxa21 @kwannoel

Copy link
Contributor

@kwannoel kwannoel left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@wenym1 wenym1 force-pushed the yiming/snapshot-backfill-progress-state branch from 3977f66 to d53453b Compare January 7, 2025 06:36
@wenym1 wenym1 added this pull request to the merge queue Jan 7, 2025
Merged via the queue into main with commit 189319d Jan 7, 2025
33 of 34 checks passed
@wenym1 wenym1 deleted the yiming/snapshot-backfill-progress-state branch January 7, 2025 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants