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

Improve errant GTID detection in ERS to handle more cases. #16926

Merged
merged 10 commits into from
Oct 28, 2024

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Oct 10, 2024

Description

This PR adds the code changes for reworking the errant GTID detection in ERS. As proposed in #16724 (comment), we now also use the reparent journal length as an extra data point for GTID detection. All the different cases listed in #16274 have been added as unit tests in this PR, and the expectations of the algorithm have been verified.

Since, ReadReparentJournalInfo is a new RPC, there can be customers that upgrade Vitess multiple versions at a time (we are adding the new RPC in v21, but it is not available in releases prior to that). In this case, the vttablets won't have the RPC implemented. Since we don't want ERS to stop working in this situation, we have to keep the legacy errant GTID code around for this scenario. So, if reading the reparent journal information fails on any tablet, then we revert to using that legacy errant GTID detection code.

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 Oct 10, 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 Oct 10, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 10, 2024
@GuptaManan100 GuptaManan100 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Cluster management 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 Oct 10, 2024
Copy link

codecov bot commented Oct 10, 2024

Codecov Report

Attention: Patch coverage is 84.53039% with 28 lines in your changes missing coverage. Please review.

Project coverage is 67.15%. Comparing base (be0bca3) to head (183d070).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vttablet/tabletmanager/rpc_replication.go 0.00% 14 Missing ⚠️
go/vt/vtctl/reparentutil/emergency_reparenter.go 94.28% 6 Missing ⚠️
go/vt/mysqlctl/reparent.go 0.00% 2 Missing ⚠️
go/vt/vtcombo/tablet_map.go 0.00% 2 Missing ⚠️
go/vt/vttablet/faketmclient/fake_client.go 0.00% 2 Missing ⚠️
go/vt/vttablet/grpctmclient/client.go 81.81% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16926      +/-   ##
==========================================
- Coverage   67.16%   67.15%   -0.01%     
==========================================
  Files        1571     1571              
  Lines      252093   252228     +135     
==========================================
+ Hits       169314   169381      +67     
- Misses      82779    82847      +68     

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

go/mysql/replication/replication_status.go Outdated Show resolved Hide resolved
go/mysql/replication/replication_status.go Outdated Show resolved Hide resolved
go/vt/vtctl/reparentutil/emergency_reparenter.go Outdated Show resolved Hide resolved
proto/tabletmanagerdata.proto Show resolved Hide resolved
go/mysql/replication/replication_status.go Outdated Show resolved Hide resolved
go/vt/vtctl/reparentutil/emergency_reparenter.go Outdated Show resolved Hide resolved
go/vt/vtctl/reparentutil/emergency_reparenter.go Outdated Show resolved Hide resolved
go/vt/vtctl/reparentutil/emergency_reparenter_test.go Outdated Show resolved Hide resolved
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.

Once unit tests have been fixed, can you check what code coverage looks like? Otherwise lgtm.

@GuptaManan100
Copy link
Member Author

GuptaManan100 commented Oct 24, 2024

This is the report from the coverage tests -

~/vitess   errant-gtid-ers-improvement ±  go tool cover -func=coverage-v2.out
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:40:             init                                    91.7%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:81:             RegisterDurability                      66.7%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:91:             GetDurabilityPolicy                     100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:100:            CheckDurabilityPolicyExists             0.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:106:            PromotionRule                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:116:            SemiSyncAckers                          100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:122:            IsReplicaSemiSync                       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:136:            PromotionRule                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:145:            SemiSyncAckers                          100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:150:            IsReplicaSemiSync                       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:163:            PromotionRule                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:172:            SemiSyncAckers                          100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:177:            IsReplicaSemiSync                       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:197:            PromotionRule                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:206:            SemiSyncAckers                          100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:211:            IsReplicaSemiSync                       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:227:            PromotionRule                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:240:            SemiSyncAckers                          0.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability.go:245:            IsReplicaSemiSync                       0.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability_funcs.go:26:       SemiSyncAckersForPrimary                100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability_funcs.go:40:       haveRevokedForTablet                    100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability_funcs.go:64:       haveRevoked                             100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/durability_funcs.go:77:       canEstablishForTablet                   100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:82:   NewEmergencyReparenter                  100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:100:  ReparentShard                           90.5%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:136:  getLockAction                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:147:  reparentShardLocked                     85.5%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:330:  waitForAllRelayLogsToApply              100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:397:  findMostAdvanced                        88.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:454:  promoteIntermediateSource               100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:494:  reparentReplicas                        94.7%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:674:  isIntermediateSourceIdeal               100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:689:  identifyPrimaryCandidate                94.7%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:741:  filterValidCandidates                   100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:777:  findErrantGTIDs                         95.3%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:885:  gatherReparenJournalInfo                100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:82:     NewPlannedReparenter                    100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:101:    ReparentShard                           85.2%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:145:    getLockAction                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:161:    preflightChecks                         95.7%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:219:    performGracefulPromotion                100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:318:    performInitialPromotion                 100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:349:    performPartialPromotionRecovery         100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:374:    performPotentialPromotion               100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:499:    reparentShardLocked                     89.6%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:646:    reparentTablets                         100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/planned_reparenter.go:745:    verifyAllTabletsReachable               100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/reparent_sorter.go:39:        newReparentSorter                       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/reparent_sorter.go:49:        Len                                     100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/reparent_sorter.go:52:        Swap                                    100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/reparent_sorter.go:61:        Less                                    93.8%
vitess.io/vitess/go/vt/vtctl/reparentutil/reparent_sorter.go:103:       sortTabletsForReparent                  100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/replication.go:45:            FindPositionsOfAllCandidates            100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/replication.go:114:           ReplicaWasRunning                       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/replication.go:127:           SQLThreadWasRunning                     100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/replication.go:144:           SetReplicationSource                    0.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/replication.go:177:           stopReplicationAndBuildStatusMaps       100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/replication.go:321:           WaitForRelayLogsToApply                 100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:66:                   ElectNewPrimary                         95.1%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:164:                  findPositionAndLagForTablet             89.5%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:206:                  FindCurrentPrimary                      100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:248:                  ShardReplicationStatuses                0.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:294:                  getValidCandidatesAndPositionsAsList    88.9%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:309:                  restrictValidCandidates                 88.9%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:325:                  findCandidate                           100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:343:                  getTabletsWithPromotionRules            100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:354:                  waitForCatchUp                          100.0%
vitess.io/vitess/go/vt/vtctl/reparentutil/util.go:380:                  GetBackupCandidates                     100.0%
total:                                                                  (statements)                            91.0%

The two that are important to note are -

vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:777:  findErrantGTIDs                         95.3%
vitess.io/vitess/go/vt/vtctl/reparentutil/emergency_reparenter.go:885:  gatherReparenJournalInfo                100.0%

The only lines untested by the unit tests in findErrantGTIDs have to deal with getting an error back from replication.FindErrantGTIDs which is impossible to get for any valid input. replication.FindErrantGTIDs only fails if the GTIDs provided are not MySQL56 variant, but we already check for that much before in FindPositionsOfAllCandidates.

Overall, we are going from 90.5% coverage to 91% coverage in this PR.

@GuptaManan100 GuptaManan100 merged commit 6b31605 into vitessio:main Oct 28, 2024
101 checks passed
@GuptaManan100 GuptaManan100 deleted the errant-gtid-ers-improvement branch October 28, 2024 03:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Cluster management Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: vtorc ERS incorrectly flags replica as having errant GTIDs
3 participants