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

vtorc: use golang.org/x/sync/semaphore, add flag for db concurrency #17837

Merged
merged 2 commits into from
Feb 28, 2025

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Feb 20, 2025

Description

This PR migrates the concurrency control for VTOrc's backend to use golang.org/x/sync/semaphore and a flag is added to control the limit

Related Issue(s)

#17330

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

Copy link
Contributor

vitess-bot bot commented Feb 20, 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 Feb 20, 2025
@timvaillancourt timvaillancourt changed the title vtorc: use golang.org/x/sync/semaphore, add flag for db concurrency vtorc: use golang.org/x/sync/semaphore, add flag for db concurrency Feb 20, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 20, 2025
@timvaillancourt timvaillancourt added Type: Internal Cleanup Component: VTorc Vitess Orchestrator integration labels Feb 20, 2025
@timvaillancourt timvaillancourt self-assigned this Feb 20, 2025
@timvaillancourt timvaillancourt 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 Feb 20, 2025
@timvaillancourt timvaillancourt marked this pull request as ready for review February 20, 2025 22:05
Copy link

codecov bot commented Feb 20, 2025

Codecov Report

Attention: Patch coverage is 65.21739% with 8 lines in your changes missing coverage. Please review.

Project coverage is 67.47%. Comparing base (2118bc3) to head (ea07036).
Report is 23 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/config/config.go 50.00% 4 Missing ⚠️
go/vt/vtorc/inst/instance_dao.go 73.33% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17837      +/-   ##
==========================================
+ Coverage   67.45%   67.47%   +0.02%     
==========================================
  Files        1592     1593       +1     
  Lines      258167   258903     +736     
==========================================
+ Hits       174143   174702     +559     
- Misses      84024    84201     +177     

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

@timvaillancourt timvaillancourt force-pushed the vtorc-instance-semaphore branch from 0fbc78e to 0edc405 Compare February 21, 2025 19:11
Comment on lines +91 to +95
ctx, cancel := context.WithTimeout(context.Background(), maxBackendOpTime)
defer cancel()

if err := instanceWriteSem.Acquire(ctx, 1); err != nil {
return err
Copy link
Member

Choose a reason for hiding this comment

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

We didn't have a test before, but maybe its worth adding one to check that these concurrency controls are respected.

Copy link
Contributor Author

@timvaillancourt timvaillancourt Feb 24, 2025

Choose a reason for hiding this comment

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

@GuptaManan100 sounds good 👍

I've been optimizing code as I come across it lately and only now I see ExecDBWriteFunc is used only in a handful of write operations and instanceReadChan/instanceReadSem is never used

So some more cleanup is needed. Do we want all reads/writes to respect a limit? And considering a majority of reads/writes in VTOrc aren't respecting a limit, do we need one? 🤔

Copy link
Member

Choose a reason for hiding this comment

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

This is fine too, but if we want to make all the read and write calls acqurie this lock too, then that would technically be more correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@GuptaManan100 I'm torn, I suspect this semaphore made more sense when the backend was remote and not in-memory

For sqlite3 there is a single writer so I think it already will constrain concurrency, so potentially only a read limit will be useful 🤔

I merged this PR too soon when I saw it had 2 x reviews, but I can follow up with whatever we decide

Signed-off-by: Tim Vaillancourt <[email protected]>
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.

Nice improvement!

@deepthi deepthi merged commit 7958251 into vitessio:main Feb 28, 2025
103 checks passed
@timvaillancourt timvaillancourt deleted the vtorc-instance-semaphore branch February 28, 2025 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTorc Vitess Orchestrator integration Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants