Skip to content

vtorc: add keyspace/shard labels to recoveries stats#18304

Merged
GuptaManan100 merged 6 commits intovitessio:mainfrom
timvaillancourt:vtorc-recoveries-labels
Jun 27, 2025
Merged

vtorc: add keyspace/shard labels to recoveries stats#18304
GuptaManan100 merged 6 commits intovitessio:mainfrom
timvaillancourt:vtorc-recoveries-labels

Conversation

@timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented May 27, 2025 •
edited
Loading

Description

This PR adds Keyspace and Shard to the stats labels of VTOrc recoveries

Related Issue(s)

Resolves #18305

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

@timvaillancourt
vtorc: add keyspace/shard labels to recoveries stats
e971935 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt timvaillancourt self-assigned this May 27, 2025
@timvaillancourt timvaillancourt added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Observability Pull requests that touch tracing/metrics/monitoring labels May 27, 2025
@vitess-bot
Copy link
Contributor

vitess-bot bot commented May 27, 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 the Component: VTOrc Vitess Orchestrator integration label May 27, 2025
@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 27, 2025
@timvaillancourt timvaillancourt removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels May 27, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone May 27, 2025
@timvaillancourt timvaillancourt removed the NeedsIssue A linked issue is missing for this Pull Request label May 27, 2025
timvaillancourt
timvaillancourt commented May 27, 2025
View reviewed changes
go/vt/vtorc/logic/topology_recovery.go
)

var (
actionableRecoveriesNames = []string{
Copy link
Contributor Author

@timvaillancourt timvaillancourt May 27, 2025

Choose a reason for hiding this comment

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

stats.NewCountersWithMultiLabels does not support a ...string to init with zero, so this becomes unused

@timvaillancourt timvaillancourt mentioned this pull request May 27, 2025
Merged
5 tasks
@timvaillancourt
add keyspace/shard to utils.WaitForSuccessfulRecoveryCount
956c261 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt timvaillancourt marked this pull request as draft May 27, 2025 18:38
@timvaillancourt
Copy link
Contributor Author

timvaillancourt commented May 27, 2025

Converted to draft to address e2e test failures

@timvaillancourt
missing updates
a6c5f32 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@codecov
Copy link

codecov bot commented May 27, 2025 •
edited
Loading

Codecov Report

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

Project coverage is 67.49%. Comparing base (2520f7f) to head (f307bb6).
Report is 16 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/logic/topology_recovery.go 0.00% 4 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #18304      +/-   ##
==========================================
- Coverage   67.49%   67.49%   -0.01%     
==========================================
  Files        1603     1603              
  Lines      262428   262442      +14     
==========================================
+ Hits       177114   177123       +9     
- Misses      85314    85319       +5

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

@timvaillancourt timvaillancourt marked this pull request as ready for review May 27, 2025 20:43
deepthi
deepthi approved these changes Jun 5, 2025
View reviewed changes
Copy link
Collaborator

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

Changes look fine. Do we need to add this to the release notes summary?

@timvaillancourt
Copy link
Contributor Author

timvaillancourt commented Jun 5, 2025

Changes look fine. Do we need to add this to the release notes summary?

@deepthi thanks! Probably, because there is a minor behaviour change.

Before, this metric would start with zeroed-out values for all the possible types. With MultiLabels that isn't supported, meaning the metrics are empty until something happens

@timvaillancourt
Copy link
Contributor Author

timvaillancourt commented Jun 11, 2025

@deepthi: added changelog notes. Your feedback is appreciated!

cc @GuptaManan100 for 💡/ 👀

@timvaillancourt
add extra note
f307bb6 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@GuptaManan100 GuptaManan100 merged commit aa68b96 into vitessio:main Jun 27, 2025
104 of 117 checks passed
@timvaillancourt timvaillancourt deleted the vtorc-recoveries-labels branch June 27, 2025 23:46
morgo added a commit to morgo/vitess that referenced this pull request Jul 7, 2025
@morgo
Merge remote-tracking branch 'origin/master' into fix-topo-import-to-…
aa4be6e 
…tests

* origin/master: (32 commits)
  test: Fix race condition in TestStreamRowsHeartbeat (vitessio#18414)
  VReplication: Improve permission check logic on external tablets on SwitchTraffic (vitessio#18348)
  Perform post copy actions in atomic copy (vitessio#18411)
  Update `operator.yaml` (vitessio#18364)
  Feature(onlineddl): Add shard-specific completion to online ddl (vitessio#18331)
  Set parsed comments in operator for subqueries (vitessio#18369)
  `vtorc`: move shard primary timestamp to time type (vitessio#18401)
  `vtorc`: rename `isClusterWideRecovery` -> `isShardWideRecovery` (vitessio#18351)
  `vtorc`: remove dupe keyspace/shard in replication analysis (vitessio#18395)
  Topo: Add NamedLock test for zk2 and consul and get them passing (vitessio#18407)
  Handle MySQL 9.x as New Flavor in getFlavor() (vitessio#18399)
  Add support for sending grpc server backend metrics via ORCA (vitessio#18282)
  asthelpergen: add design documentation (vitessio#18403)
  `vtorc`: add keyspace/shard labels to recoveries stats (vitessio#18304)
  `vtorc`: cleanup `database_instance` location fields (vitessio#18339)
  avoid derived tables for UNION when possible (vitessio#18393)
  [Bugfix] Broken Heartbeat system in Row Streamer (vitessio#18390)
  Update MAINTAINERS.md (vitessio#18394)
  move vmg to emeritus (vitessio#18388)
  Make sure to check if the server is closed in etcd2topo (vitessio#18352)
  ...
@systay systay mentioned this pull request Aug 29, 2025
Merged
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Aug 29, 2025
@timvaillancourt
vtorc: add keyspace/shard labels to recoveries stats (vitessio#18304)
45c8884 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt timvaillancourt mentioned this pull request Aug 29, 2025
Closed
5 tasks
@BrewTestBot BrewTestBot mentioned this pull request Nov 4, 2025
Merged
tanjinx pushed a commit to slackhq/vitess that referenced this pull request Nov 4, 2025
@timvaillancourt @tanjinx
vtorc: add keyspace/shard labels to recoveries stats (vitessio#18304)
5e69648 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
@tanjinx tanjinx mentioned this pull request Nov 4, 2025
Merged
5 tasks
tanjinx added a commit to slackhq/vitess that referenced this pull request Nov 6, 2025
@tanjinx @timvaillancourt
vtorc: add keyspace/shard labels to recoveries stats (vitessio#18304)…
384f0d1 
… (#740)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-authored-by: Tim Vaillancourt <tim@timvaillancourt.com>
tanjinx added a commit to slackhq/vitess that referenced this pull request Nov 10, 2025
@tanjinx @timvaillancourt
vtorc: add keyspace/shard labels to recoveries stats (vitessio#18304)…
c8b2de1 
… (#740)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-authored-by: Tim Vaillancourt <tim@timvaillancourt.com>
sbaker617 pushed a commit to slackhq/vitess that referenced this pull request Feb 5, 2026
@tanjinx @timvaillancourt @sbaker617
vtorc: add keyspace/shard labels to recoveries stats (vitessio#18304)…
de27669 
… (#740)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-authored-by: Tim Vaillancourt <tim@timvaillancourt.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

2 more reviewers

@deepthi deepthi deepthi approved these changes

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@timvaillancourt timvaillancourt

Labels

Component: Observability Pull requests that touch tracing/metrics/monitoring Component: VTOrc Vitess Orchestrator integration Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Milestone

v23.0.0

Development

Successfully merging this pull request may close these issues.

Feature Request: add keyspace/shard labels to VTOrc recoveries stats

3 participants

@timvaillancourt @deepthi @GuptaManan100