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: cleanup discover queue, add concurrency flag #17825

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

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Feb 19, 2025

Description

This PR cleans up the VTOrc discover queue code, mainly by removing all locking from .Consume(); this was achieved by adding type queueItem struct and pushing this to the channel instead, with the key and time.Time included. Previously this time.Time was stored in a map with mutex locks

The .QueueLen() now returns just the len() of the queue channel. Before this metric would include the length of the channel plus all that are "in processing" (between .Consume() and .Release()), which I'm unsure is necessary. Simplifying this removed the need for a lock in .QueueLen()

Finally, the --discovery-max-concurrency flag was added to control how many workers consume the discovery queue

Benchmark:

tvaillancourt@tvailla-ltmawfe vitess % go test -v -bench=. ./go/vt/vtorc/discovery/...
=== RUN   TestQueue
--- PASS: TestQueue (0.00s)
goos: darwin
goarch: arm64
pkg: vitess.io/vitess/go/vt/vtorc/discovery
cpu: Apple M3 Max
BenchmarkQueues
BenchmarkQueues/New
BenchmarkQueues/New-14         	    4726	    244573 ns/op
BenchmarkQueues/Legacy
BenchmarkQueues/Legacy-14      	    3610	    338468 ns/op
PASS
ok  	vitess.io/vitess/go/vt/vtorc/discovery	3.923s

NOTE: New == this PR, Legacy == current queue

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

Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt added Type: Enhancement Logical improvement (somewhere between a bug and feature) Type: Performance Component: VTorc Vitess Orchestrator integration labels Feb 19, 2025
@timvaillancourt timvaillancourt self-assigned this Feb 19, 2025
Copy link
Contributor

vitess-bot bot commented Feb 19, 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 19, 2025
@timvaillancourt timvaillancourt removed NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Feb 19, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 19, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

Attention: Patch coverage is 77.41935% with 7 lines in your changes missing coverage. Please review.

Project coverage is 67.47%. Comparing base (0c6ad63) to head (45e87fd).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/config/config.go 0.00% 4 Missing ⚠️
go/vt/vtorc/logic/vtorc.go 0.00% 2 Missing ⚠️
go/vt/vtorc/discovery/queue.go 96.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17825      +/-   ##
==========================================
+ Coverage   67.44%   67.47%   +0.03%     
==========================================
  Files        1592     1592              
  Lines      258076   258159      +83     
==========================================
+ Hits       174051   174201     +150     
+ Misses      84025    83958      -67     

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

Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt changed the title vtorc: lockless discover queue, add concurrency flag vtorc: cleanup discover queue, add concurrency flag Feb 19, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt timvaillancourt removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request labels Feb 20, 2025
@timvaillancourt timvaillancourt marked this pull request as ready for review February 20, 2025 12:47

// QueueLen returns the length of the queue.
func (q *Queue) QueueLen() int {
return len(q.queue)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The previous code did return len(q.queue) + len(q.queuedKeys) and I'm not sure why 🤔

If we see a reason I can restore this but it adds a lock. I think only metrics call this lock

Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
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: Enhancement Logical improvement (somewhere between a bug and feature) Type: Internal Cleanup Type: Performance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant