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

mysqlctld: setup a different default for onterm_timeout #15575

Merged

Conversation

dbussink
Copy link
Contributor

@dbussink dbussink commented Mar 26, 2024

Until now we've had the same timeouts for shutdown etc. across the different binaries. This doesn't provide the necessary flexibility though, since for example mysqlctld will need longer timeouts.

This is because it needs to shut down MySQL and we need it to honor the MySQL shutdown timeout as well. This means this can take significantly longer to ensure the shutdown is clean.

It's necessary to do this, to ensure things like being able to upgrade MySQL since that depends on clean shutdowns.

Related Issue(s)

Fixes #15577

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 requested review from deepthi and ajm188 as code owners March 26, 2024 12:50
Copy link
Contributor

vitess-bot bot commented Mar 26, 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 Mar 26, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 26, 2024
Until now we've had the same timeouts for shutdown etc. across the
different binaries. This doesn't provide the necessary flexibility
though, since for example `mysqlctld` will need longer timeouts.

This is because it needs to shut down MySQL and we need it to honor the
MySQL shutdown timeout as well. This means this can take significantly
longer to ensure the shutdown is clean.

It's necessary to do this, to ensure things like being able to upgrade
MySQL since that depends on clean shutdowns.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink force-pushed the dbussink/longer-mysqctld-term-timeout branch from 96a854f to e45438b Compare March 26, 2024 13:21
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

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

Project coverage is 65.75%. Comparing base (696fe0e) to head (c204f9a).
Report is 156 commits behind head on main.

Files Patch % Lines
go/vt/servenv/servenv.go 0.00% 14 Missing ⚠️
go/cmd/vtcombo/cli/main.go 0.00% 6 Missing ⚠️
go/vt/servenv/run.go 0.00% 4 Missing ⚠️
go/cmd/mysqlctld/cli/mysqlctld.go 0.00% 1 Missing ⚠️
go/vt/mysqlctl/grpcmysqlctlserver/server.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15575      +/-   ##
==========================================
- Coverage   67.41%   65.75%   -1.67%     
==========================================
  Files        1560     1561       +1     
  Lines      192752   194851    +2099     
==========================================
- Hits       129952   128129    -1823     
- Misses      62800    66722    +3922     

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

@dbussink dbussink changed the title Setup individual timeouts for each binary Setup individual timeouts mysqlctld Mar 26, 2024
@deepthi deepthi removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 26, 2024
Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

I am onboard with this change. However it is technically a backwards incompatible change, so we need to document it as such.
Let's create an issue and write a release note. I believe website flag docs will also need to be regenerated unless that is now automatically triggered by merges on the main repo.

go/flags/endtoend/mysqlctld.txt Show resolved Hide resolved
@deepthi deepthi added the release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) label Mar 26, 2024
@deepthi deepthi requested review from GuptaManan100 and removed request for ajm188 March 26, 2024 18:48
Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

LGTM. Let's get the issue created and release note added, and I can approve after I review the release note.
For the record, I think it is indeed a good idea to start moving globals at the servenv level into structs that can be overridden by each binary, so thank you for starting us down this path.

@@ -87,7 +87,7 @@ var (
mysqlPort = 3306
mysqlSocket string
mysqlTimeout = 5 * time.Minute
mysqlShutdownTimeout = 5 * time.Minute
mysqlShutdownTimeout = mysqlctl.DefaultShutdownTimeout
Copy link
Member

Choose a reason for hiding this comment

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

Insane that we were defining this 5 minutes in multiple places.

@deepthi deepthi changed the title Setup individual timeouts mysqlctld mysqlctld: setup a different default for onterm_timeout Mar 26, 2024
@deepthi
Copy link
Member

deepthi commented Mar 26, 2024

I believe website flag docs will also need to be regenerated unless that is now automatically triggered by merges on the main repo.

They are generated by vitess-bot, so I've removed the label for website docs.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink added Type: Bug Component: TabletManager and removed NeedsIssue A linked issue is missing for this Pull Request labels Mar 26, 2024
@dbussink
Copy link
Contributor Author

@deepthi Added a release note as well.

@dbussink dbussink removed the release notes (needs details) This PR needs to be listed in the release notes in a dedicated section (deprecation notice, etc...) label Mar 26, 2024
@deepthi deepthi merged commit 308f1fc into vitessio:main Mar 26, 2024
102 of 106 checks passed
@deepthi deepthi deleted the dbussink/longer-mysqctld-term-timeout branch March 26, 2024 21:48
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.

Bug Report: Default on term timeout for mysqctld is broken
3 participants