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.

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

ApplySchema: reroute ALTER VITESS_MIGRATION ... THROTTLE ... via UpdateThrottlerConfig #16030

Merged
merged 3 commits into from
Jun 2, 2024
Merged

ApplySchema: reroute ALTER VITESS_MIGRATION ... THROTTLE ... via UpdateThrottlerConfig #16030

merged 3 commits into from
Jun 2, 2024

Conversation

shlomi-noach
Copy link
Contributor

Description

Fixes #16029, this PR implements UpdateThrottlerConfig for ALTER VITESS_MIGRATION ... THROTTLE|UNTHROTTLE commands in ApplySchema.

Related Issue(s)

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
endtoend: validating 'alter vitess_migration throttle all' is persist…
3a016d2 
…ed in topo. Initially this is not the case and the test should fail

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
ApplySchema: special handling of 'ALTER VITESS_MIGRATION ... [UN]THRO…
8a18b88 
…TTLE' command

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach requested a review from a team May 30, 2024 10:28
@shlomi-noach shlomi-noach requested a review from deepthi as a code owner May 30, 2024 10:28
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented May 30, 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 May 30, 2024
@shlomi-noach shlomi-noach added Type: Bug Component: TabletManager Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Component: Throttler and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says 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 May 30, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 30, 2024
@shlomi-noach shlomi-noach changed the title Apply schema throttle topo ApplySchema: reroute ALTER VITESS_MIGRATION ... THROTTLE ... via UpdateThrottlerConfig May 30, 2024
@shlomi-noach shlomi-noach mentioned this pull request May 30, 2024
Closed
49 tasks
@codecov Codecov
Copy link

codecov bot commented May 30, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 6.66667% with 56 lines in your changes are missing coverage. Please review.

Project coverage is 68.23%. Comparing base (0a86449) to head (09b61fd).
Report is 8 commits behind head on main.

Files Patch % Lines
go/vt/schemamanager/tablet_executor.go 6.66% 56 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #16030      +/-   ##
==========================================
- Coverage   68.23%   68.23%   -0.01%     
==========================================
  Files        1541     1541              
  Lines      197115   197223     +108     
==========================================
+ Hits       134503   134574      +71     
- Misses      62612    62649      +37

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

mattlord
mattlord approved these changes May 31, 2024
View reviewed changes
go/test/endtoend/tabletmanager/throttler_topo/throttler_test.go
assert.Equal(t, throttlerapp.OnlineDDLName.String(), appRule.Name)
assert.EqualValues(t, 1.0, appRule.Ratio)
})
t.Run("unthrottling via ApplySchema", func(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

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

If we're going to test the unthrottling as well, then IMO it makes sense to validate the keyspace config afterwards too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

go/vt/schemamanager/tablet_executor.go
Comment on lines +254 to +258
// We have already locked the keyspace
ki, err := exec.ts.GetKeyspace(ctx, req.Keyspace)
if err != nil {
return err
}
Copy link
Contributor

@mattlord mattlord May 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Where do we do that (lock the keyspace) in this call path? We lock it in vtgate before sending the query down to the vttablet? In this PR it looks like the vttablet parses the incoming query in the query service and then calls this function.

Copy link
Contributor

Choose a reason for hiding this comment

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

If we do lock it in vtgate, then that lock info should be attached to the context we get and we can use CheckKeyspaceLocked to be sure we have locked it:

if err = topo.CheckKeyspaceLocked(ctx, req.Keyspace); err != nil {
	return err
}

That would protect us in the case that somehow the locks lease expired or someone executed this directly against a tablet using one of the Execute RPCs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, we're already doing just that here: https://github.com/planetscale/vitess/blob/0d8ca1be54ec50feda41b75e750619df15c5b747/go/vt/topo/srv_keyspace.go#L397-L401

So the safety aspect is already addressed. From there it's only my curiosity. 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mattlord it's locked here:

vitess/go/vt/schemamanager/tablet_executor.go

Line 302 in ab6c7af

ctx, unlock, lockErr := exec.ts.LockKeyspace(ctx, exec.keyspace, "ApplySchemaKeyspace")

@shlomi-noach
validate keyspace configuration after unthrottle
09b61fd 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach merged commit 79b66d6 into vitessio:main Jun 2, 2024
93 checks passed
@shlomi-noach shlomi-noach deleted the apply-schema-throttle-topo branch June 2, 2024 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord approved these changes

@deepthi deepthi deepthi approved these changes

Assignees
No one assigned
Labels
Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Component: TabletManager Component: Throttler Type: Bug
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.

ApplySchema command should reroute ALTER VITESS_MIGRATION ... THROTTLE ... via UpdateThrottlerConfig
3 participants
@shlomi-noach @deepthi @mattlord