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

Online DDL: dynamic cut-over threshold via ALTER VITESS_MIGRATION ... CUTOVER_THRESHOLD ... command #17126

Merged

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Oct 31, 2024

Description

This PR introduces the following command (example):

ALTER VITESS_MIGRATION '03740aca_9771_11ef_a0c8_b27afeff3c83' CUTOVER_THRESHOLD '15s'

This can be applied to any migration, either just submitted, scheduled to run, running, cancelled, ... (in short: at any state). However the case, the value gets persisted to a new column: schema_migrations.cutover_threshold_seconds.

The value in that column is an integer, and is the truncated value of the given argument. e.g. if given CUTOVER_THRESHOLD '7500ms' then the value stored is 7 (seconds).

The value is further sanitized: it must be in the range 5s..30s and forced into that range if outside. A value 0, or if never indicated in the first place, implies the default cut-over threshold which is 10s.

The value can be updated at any time and as many times. As a migration goes into cut-over, it reads and uses the current value from the table.

Related Issue(s)

Fixes #17123

Docs: vitessio/website#1879

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) labels Oct 31, 2024
Copy link
Contributor

vitess-bot bot commented Oct 31, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 31, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 31, 2024
@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Oct 31, 2024
@shlomi-noach
Copy link
Contributor Author

Docs: vitessio/website#1879

@shlomi-noach shlomi-noach removed the NeedsWebsiteDocsUpdate What it says label Oct 31, 2024
@shlomi-noach
Copy link
Contributor Author

Code Coverage fails -- this functionality is tested in e2e tests.

Copy link

codecov bot commented Oct 31, 2024

Codecov Report

Attention: Patch coverage is 14.47368% with 65 lines in your changes missing coverage. Please review.

Project coverage is 67.40%. Comparing base (4980d6f) to head (8fa16d5).
Report is 14 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vttablet/onlineddl/executor.go 14.49% 59 Missing ⚠️
go/vt/sqlparser/ast_format.go 20.00% 4 Missing ⚠️
go/vt/vttablet/tabletserver/query_executor.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17126   +/-   ##
=======================================
  Coverage   67.39%   67.40%           
=======================================
  Files        1570     1570           
  Lines      252892   252944   +52     
=======================================
+ Hits       170437   170493   +56     
+ Misses      82455    82451    -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

e.migrationMutex.Lock()
defer e.migrationMutex.Unlock()

threshold = safeMigrationCutOverThreshold(threshold)
Copy link
Contributor

Choose a reason for hiding this comment

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

IMO it's better to return an error if the user is e.g. trying to set it to 90s to avoid user confusion — especially since this isn't driven by a flag where we can explicitly tell the user about the valid range and also potentially check the input value on the client side. I don't feel strongly about it though (I do see that we're documenting it).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We now return an error if the user's value is out of bounds (< 5s or > 30s). 0 is allowed and presets the threshold value to the factory default.

Copy link
Contributor Author

@shlomi-noach shlomi-noach Nov 4, 2024

Choose a reason for hiding this comment

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

Docs PR updated.

@shlomi-noach shlomi-noach merged commit c5d0ecc into vitessio:main Nov 20, 2024
99 checks passed
@shlomi-noach shlomi-noach deleted the onlineddl-dynamic-cutover-timeout branch November 20, 2024 07:48
rvrangel pushed a commit to rvrangel/vitess that referenced this pull request Nov 21, 2024
…. CUTOVER_THRESHOLD ...` command (vitessio#17126)

Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Renan Rangel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: dynamic cut-over threshold in Online DDL
3 participants