Skip to content

vtorc: deprecate snapshot topology feature in v24 #19070

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.

Sign up for GitHub

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

Jump to bottom
Merged
timvaillancourt merged 4 commits into from
Jan 27, 2026
Merged

vtorc: deprecate snapshot topology feature in v24 #19070

timvaillancourt merged 4 commits into from
Jan 27, 2026

Conversation

@timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Dec 23, 2025 •
edited
Loading

Description

This PR is the v24-half of the deprecation explained in #18691

Related Issue(s)

#18691

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

AI Disclosure

@github-actions github-actions bot added this to the v24.0.0 milestone Dec 23, 2025
@vitess-bot vitess-bot bot added NeedsWebsiteDocsUpdate What it says NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work 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 Dec 23, 2025
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 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.

@timvaillancourt timvaillancourt added Type: Documentation Component: VTorc Vitess Orchestrator integration Component: Documentation docs related issues/PRs 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 Dec 23, 2025
@timvaillancourt timvaillancourt marked this pull request as ready for review December 23, 2025 15:21
timvaillancourt
timvaillancourt commented Dec 23, 2025
View reviewed changes
changelog/24.0/24.0.0/summary.md
#### <a id="vtorc-deprecated-metric-removed"/>Deprecated VTOrc Metric Removed</a>

VTOrc now supports a `--cell` flag that specifies which Vitess cell the VTOrc process is running in. The flag is optional in v24 but will be required in v25+, similar to VTGate's `--cell` flag.
The `DiscoverInstanceTimings` metric has been removed from VTOrc in v24. This metric was deprecated in v23.
Copy link
Contributor Author

@timvaillancourt timvaillancourt Dec 23, 2025

Choose a reason for hiding this comment

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

Corrected AI slop from a previous doc PR here: metrics are capitalized

@timvaillancourt timvaillancourt self-assigned this Dec 23, 2025
@promptless
Copy link
Contributor

promptless bot commented Dec 23, 2025

📝 Documentation updates detected!

New suggestion: Add deprecation notice for VTOrc snapshot topology flag

@timvaillancourt timvaillancourt mentioned this pull request Dec 23, 2025
Open
@timvaillancourt timvaillancourt enabled auto-merge (squash) December 24, 2025 15:04
@github-actions
Copy link
Contributor

github-actions bot commented Jan 23, 2026

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jan 23, 2026
@timvaillancourt timvaillancourt removed the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jan 27, 2026
@codecov
Copy link

codecov bot commented Jan 27, 2026 •
edited
Loading

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 69.90%. Comparing base (43ba94b) to head (32c744d).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/logic/vtorc.go 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #19070      +/-   ##
==========================================
- Coverage   69.90%   69.90%   -0.01%     
==========================================
  Files        1611     1611              
  Lines      215948   215949       +1     
==========================================
- Hits       150959   150949      -10     
- Misses      64989    65000      +11

☔ 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.

mattlord
mattlord approved these changes Jan 27, 2026
View reviewed changes
go/vt/vtorc/logic/vtorc.go
var recoveryEntrance int64
var snapshotTopologiesTick <-chan time.Time
if config.GetSnapshotTopologyInterval() > 0 {
log.Warning("--snapshot-topology-interval is deprecated and will be removed in v25+")
Copy link
Member

@mattlord mattlord Jan 27, 2026

Choose a reason for hiding this comment

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

I think it's also good to try and leverage the MarkDeprecated and similar features of Cobra for the flag at that level so that people see e.g. warnings on the console, don't even see an option in the --help output anymore, etc.

@timvaillancourt timvaillancourt merged commit 29e2f98 into vitessio:main Jan 27, 2026
103 of 105 checks passed
@timvaillancourt timvaillancourt deleted the vtorc-snapshot-topology-deprecation branch January 27, 2026 18:54
@promptless
Copy link
Contributor

promptless bot commented Jan 27, 2026

📝 Documentation updates detected!

New suggestion: Add deprecation notice for VTOrc snapshot topology feature

mhamza15 pushed a commit that referenced this pull request Jan 29, 2026
@timvaillancourt @mhamza15
vtorc: deprecate snapshot topology feature in v24 (#19070)
174a488 
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

Reviewers

@mattlord mattlord mattlord approved these changes

@mhamza15 mhamza15 mhamza15 approved these changes

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

@arthurschreiber arthurschreiber Awaiting requested review from arthurschreiber

Assignees

@timvaillancourt timvaillancourt

Labels

Component: Documentation docs related issues/PRs Component: VTorc Vitess Orchestrator integration Type: Documentation

Projects

None yet

Milestone

v24.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@timvaillancourt @mattlord @mhamza15