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

Allow for specifying a specific MySQL shutdown timeout #17923

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Allow for specifying a specific MySQL shutdown timeout #17923

wants to merge 2 commits into from
+1,374 −969

Conversation

dbussink
Copy link
Contributor

@dbussink dbussink commented Mar 6, 2025

This adds an override flag to be able to set the shutdown timeout for MySQL for an individual backup without having to override the global flag for a tablet.

Related Issue(s)

Fixes #17920

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

@dbussink dbussink added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Backup and Restore labels Mar 6, 2025
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 6, 2025

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 Mar 6, 2025
@dbussink dbussink 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 Mar 6, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 6, 2025
@codecov Codecov
Copy link

codecov bot commented Mar 6, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 45.76271% with 32 lines in your changes missing coverage. Please review.

Project coverage is 67.54%. Comparing base (a3a52c0) to head (5be710b).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtctl/backup.go 0.00% 15 Missing ⚠️
go/cmd/vtctldclient/command/backups.go 18.75% 13 Missing ⚠️
go/vt/vttablet/tabletmanager/rpc_backup.go 66.66% 4 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #17923      +/-   ##
==========================================
- Coverage   67.56%   67.54%   -0.02%     
==========================================
  Files        1597     1597              
  Lines      259782   259810      +28     
==========================================
- Hits       175516   175491      -25     
- Misses      84266    84319      +53

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

🚀 New features to boost your workflow:
  • ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@deepthi deepthi requested a review from frouioui March 6, 2025 17:43
frouioui
frouioui reviewed Mar 6, 2025
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

I could not find E2E tests in the codebase where we run vtctldclient Backup/BackupShard. It would be nice to add one.

go/cmd/vtctldclient/command/backups.go
Concurrency int32
IncrementalFromPos string
UpgradeSafe bool
MysqlShutdownTimeout time.Duration
Copy link
Member

Choose a reason for hiding this comment

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

New CLI documentation will have to be generated for this subcommand: https://vitess.io/docs/22.0/reference/programs/vtctldclient/vtctldclient_backup/

This should be picked up when we re-generate the CLI docs before v22.0.0, but just noting it here.

@dbussink
Copy link
Contributor Author

dbussink commented Mar 7, 2025

@frouioui we could add an end to end test, but it wouldn't really be to exercise the new option.

Tests are really small scale setups here and to reproduce this kind of timeout problem specifically you need both a very large dataset and also modify it significantly before attempting the shutdown.

If you're talking about just having something to validate it end to end, then sure, it does add some value for that.

dbussink added 2 commits March 10, 2025 10:14
@dbussink
Allow for specifying a specific MySQL shutdown timeout
3495046 
This adds an override flag to be able to set the shutdown timeout for
MySQL for an individual backup without having to override the global
flag for a tablet.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink
Capitalize
5be710b 
Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink dbussink force-pushed the dbussink/allow-explicit-mysql-shutdown-timeout branch from 9ab2cf2 to 5be710b Compare March 10, 2025 09:15
@dbussink
Copy link
Contributor Author

I could not find E2E tests in the codebase where we run vtctldclient Backup/BackupShard. It would be nice to add one.

Wait, isn't this running through vtctldclient:

vitess/go/test/endtoend/backup/vtctlbackup/backup_utils.go

Lines 478 to 482 in 209d940

verifyInitialReplication(t)
output, err := localCluster.VtctldClientProcess.ExecuteCommandWithOutput("Backup", primary.Alias)
require.Error(t, err)
assert.Contains(t, output, "type PRIMARY cannot take backup. if you really need to do this, rerun the backup command with --allow_primary")

So we already have this?

@frouioui
Copy link
Member

@dbussink you are right, apologies for the oversight.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouioui frouioui frouioui approved these changes

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@notfelineit notfelineit Awaiting requested review from notfelineit notfelineit is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Component: Backup and Restore Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: Allow overriding the shutdown time for upgrade safe backups
2 participants
@dbussink @frouioui