Skip to content

Refactor vtcombo flags - Part 2#18297

Merged
deepthi merged 1 commit intovitessio:mainfrom
mounicasruthi:flags-refactor-vtcombo-pt2
May 28, 2025
Merged

Refactor vtcombo flags - Part 2#18297
deepthi merged 1 commit intovitessio:mainfrom
mounicasruthi:flags-refactor-vtcombo-pt2

Conversation

@mounicasruthi
Copy link
Collaborator

@mounicasruthi mounicasruthi commented May 23, 2025

Description

This PR is a part of an ongoing change to support the transition from underscores (_) to dashes (-) in flag naming conventions. This PR refactors some flags specific to vtcombo binary.

Flags Updated in This PR:
--buffer-drain-concurrency
--buffer-keyspace-shards
--buffer-max-failover-duration
--buffer-min-time-between-failovers
--buffer-size
--buffer-window
--gc-check-interval
--gc-purge-check-interval
--health-check-interval
--healthcheck-retry-delay
--healthcheck-timeout
--heartbeat-on-demand-duration
--hot-row-protection-concurrent-transactions
--hot-row-protection-max-global-queue-size
--hot-row-protection-max-queue-size
--transaction-limit-by-component
--transaction-limit-by-principal
--transaction-limit-by-subcomponent
--transaction-limit-by-username
--transaction-limit-per-user
--vttablet-skip-buildinfo-tags
--wait-for-backup-interval
--warn-memory-rows
--warn-payload-size
--warn-sharded-only
--watch-replication-stream
--xbstream-restore-flags

Flag Count Before vs After:

Flags with _ Flags with -
Before 318 1760
After 262 1816

# of migrated flags: 56

Related Issue(s)

#17880

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

@vitess-bot
Copy link
Contributor

vitess-bot bot commented May 23, 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 May 23, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone May 23, 2025
@mounicasruthi mounicasruthi force-pushed the flags-refactor-vtcombo-pt2 branch from af3a915 to 799724f Compare May 23, 2025 18:56
@codecov
Copy link

codecov bot commented May 23, 2025

Codecov Report

Attention: Patch coverage is 61.36364% with 17 lines in your changes missing coverage. Please review.

Project coverage is 67.48%. Comparing base (fcfa0c8) to head (0564339).
Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vttablet/tabletserver/tabletenv/config.go 64.70% 6 Missing ⚠️
go/vt/vtgate/buffer/flags.go 64.28% 5 Missing ⚠️
go/vt/vtgate/vtgate.go 0.00% 5 Missing ⚠️
go/vt/vttablet/tabletmanager/restore.go 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18297      +/-   ##
==========================================
- Coverage   67.48%   67.48%   -0.01%     
==========================================
  Files        1603     1603              
  Lines      262337   262386      +49     
==========================================
+ Hits       177034   177059      +25     
- Misses      85303    85327      +24     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mounicasruthi mounicasruthi added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base and removed 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 May 26, 2025
@mounicasruthi mounicasruthi marked this pull request as ready for review May 26, 2025 10:44
@mounicasruthi mounicasruthi force-pushed the flags-refactor-vtcombo-pt2 branch from 799724f to 0564339 Compare May 26, 2025 12:58
@mounicasruthi mounicasruthi marked this pull request as draft May 26, 2025 13:17
@mounicasruthi mounicasruthi marked this pull request as ready for review May 26, 2025 17:25
@deepthi deepthi removed the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label May 27, 2025
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi mounicasruthi force-pushed the flags-refactor-vtcombo-pt2 branch from 0564339 to fe4d7b6 Compare May 28, 2025 20:48
@deepthi deepthi merged commit cec7812 into vitessio:main May 28, 2025
100 of 110 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: General Changes throughout the code base Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants