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

Fix for FullStatus gRPC connection pooling #15520

Closed

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Mar 19, 2024

Description

Fixes a bug in TabletManagerClient's pool dialer. In:

if client.rpcClientMap == nil {
client.rpcClientMap = make(map[string]chan *tmc)
}
c, ok := client.rpcClientMap[addr]
if !ok {
c = make(chan *tmc, concurrency)
client.rpcClientMap[addr] = c
client.mu.Unlock()

rpcClientMap caches tablet connections indefinitely based on address. If a tablet goes down, it does not get evicted from the map. If a new tablet then bootstraps with the same address, then rpcClientMap makes us continuously try connecting to that tablet, even if it's on another cluster.

The solution is to evict a tablet/connection from the map upon connection/gRPC error.

However, since said error is seen long after we've returned the cached client / dialer, the user of the client needs to proactively invalidate the cached connection. To that effect, we now return an invalidator() function that can invalidate a cached connection based on the returned error.

Related Issue(s)

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 Mar 19, 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 19, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 19, 2024
@GuptaManan100 GuptaManan100 added Type: Bug Component: VTorc Vitess Orchestrator integration Component: Throttler and 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 19, 2024
Copy link

codecov bot commented Mar 19, 2024

Codecov Report

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

Project coverage is 65.72%. Comparing base (696fe0e) to head (7da6c01).
Report is 139 commits behind head on main.

Files Patch % Lines
go/vt/vttablet/grpctmclient/client.go 81.81% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15520      +/-   ##
==========================================
- Coverage   67.41%   65.72%   -1.70%     
==========================================
  Files        1560     1560              
  Lines      192752   194594    +1842     
==========================================
- Hits       129952   127893    -2059     
- Misses      62800    66701    +3901     

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

@shlomi-noach shlomi-noach marked this pull request as ready for review March 19, 2024 11:24
@shlomi-noach shlomi-noach requested review from a team, mattlord and harshit-gangal March 19, 2024 11:25
Copy link
Member Author

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Comment on lines 193 to 196
if _, ok := status.FromError(err); !ok {
// Not a gRPC error
return
}
Copy link
Member Author

Choose a reason for hiding this comment

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

@harshit-gangal Would some error codes from MySQL also pass this check and end up causing us to invalidate the grpc connection?

go/vt/vttablet/grpctmclient/client.go Show resolved Hide resolved
GuptaManan100 and others added 2 commits March 19, 2024 18:48
Signed-off-by: Manan Gupta <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
…le/vitess into full-status-connection-pooling

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

@GuptaManan100 as @dbussink points out, adding the Close() change seems to break many tests.

Comment on lines 1142 to 1147
if err != nil {
if invalidator != nil {
invalidator(err)
}
return nil, err
}
Copy link
Member

Choose a reason for hiding this comment

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

nit: can remove passing error to invalidator

@shlomi-noach
Copy link
Contributor

Converted this PR to draft, as we explore alternative approaches: #15541, #15559

@shlomi-noach
Copy link
Contributor

A different implementation in #15562 .

@shlomi-noach shlomi-noach deleted the full-status-connection-pooling branch March 25, 2024 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants