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

Multi-metrics throttler post v21 cleanup: remove unthrottled entry from topo #17283

Merged

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Nov 26, 2024

Description

Multi metrics throttler was introduced in v21 and was backwards compatible with the v20 single-metric throttler. Compatibility included gRPC, command line flags, etc.

Starting v22, we remove single-metric throttler compatibility. This PR is a small extract of #16915, addressing a single issue: when an app is unthrottled (or expired), we now remove its configuration from topo's Keyspace record, as opposed to leaving it there with zero values.

This helps maintaining the topo record small and tidy. This could not have been done in v21 for compatibility reasons: the throttler maintains an in-memory representation of the config. Up to v20, it would not remove entries from its in-memory represenation even if those entries did not exist in the config. It would only overwrite based on existing config entries. v21 knows better and removes such entries, which is why it's only safe to submit this PR in v22.

Related Issue(s)

#15624

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

Signed-off-by: Shlomi Noach <[email protected]>
Copy link
Contributor

vitess-bot bot commented Nov 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 Nov 26, 2024
@shlomi-noach shlomi-noach 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 Nov 26, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 26, 2024
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

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

Project coverage is 67.41%. Comparing base (ab7b516) to head (de4c1f8).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/schemamanager/tablet_executor.go 0.00% 6 Missing ⚠️
go/vt/vtctl/grpcvtctldserver/server.go 0.00% 6 Missing ⚠️
go/vt/vtgate/executorcontext/vcursor_impl.go 0.00% 6 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17283   +/-   ##
=======================================
  Coverage   67.41%   67.41%           
=======================================
  Files        1576     1576           
  Lines      253417   253408    -9     
=======================================
- Hits       170846   170840    -6     
+ Misses      82571    82568    -3     

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

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

❤️ This will make it much easier to understand the config.

@shlomi-noach shlomi-noach merged commit cb66920 into vitessio:main Dec 9, 2024
100 checks passed
@shlomi-noach shlomi-noach deleted the throttler-remove-expired-config branch December 9, 2024 06:34
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