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

Add stats for shards watched by VTOrc, purge stale shards #17815

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented Feb 17, 2025

Description

This PR adds stats for what keyspace/shards are being watched by VTOrc, populated using the backend database

While adding this support I noticed records are never deleted from the backend vitess_shard table, so I added support for stale records to be deleted in a similar way to tablets: by recording what was successfully "saved" in the latest polling and removing anything that was not in that list

Related Issue(s)

Closes #17816

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 Feb 17, 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 Feb 17, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 17, 2025
// RefreshAllKeyspacesAndShards reloads the keyspace and shard information for the keyspaces that vtorc is concerned with.
func RefreshAllKeyspacesAndShards(ctx context.Context) error {
refreshAllKeyspacesAndShardsMu.Lock()
Copy link
Contributor Author

@timvaillancourt timvaillancourt Feb 17, 2025

Choose a reason for hiding this comment

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

refreshAllShards does a save + read + delete, per keyspace. Lets make sure that doesn't happen concurrently

Copy link

codecov bot commented Feb 17, 2025

Codecov Report

Attention: Patch coverage is 46.66667% with 32 lines in your changes missing coverage. Please review.

Project coverage is 67.43%. Comparing base (70114ad) to head (474115d).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/logic/keyspace_shard_discovery.go 0.00% 32 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17815      +/-   ##
==========================================
- Coverage   67.94%   67.43%   -0.52%     
==========================================
  Files        1586     1592       +6     
  Lines      255224   258136    +2912     
==========================================
+ Hits       173420   174068     +648     
- Misses      81804    84068    +2264     

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

@timvaillancourt timvaillancourt added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTorc Vitess Orchestrator integration and 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 NeedsIssue A linked issue is missing for this Pull Request labels Feb 17, 2025
@timvaillancourt timvaillancourt marked this pull request as ready for review February 17, 2025 18:10
@timvaillancourt timvaillancourt self-assigned this Feb 17, 2025
@timvaillancourt timvaillancourt force-pushed the vtorc-shards-watched-stats branch from 6942354 to c65971e Compare February 17, 2025 18:42
@timvaillancourt timvaillancourt force-pushed the vtorc-shards-watched-stats branch from 08f4c4b to eae50cb Compare February 17, 2025 19:03
@timvaillancourt timvaillancourt changed the title Add stats for shards watched by VTOrc Add stats for shards watched by VTOrc, purge stale shards Feb 17, 2025
Signed-off-by: Tim Vaillancourt <[email protected]>
Signed-off-by: Tim Vaillancourt <[email protected]>
@timvaillancourt
Copy link
Contributor Author

This is working nicely on our fork:

vitess@REDACTED:/vt$ curl -s localhost:15000/metrics | grep vtorc_shards_watched | head -10
# HELP vtorc_shards_watched Keyspace/shards currently watched
# TYPE vtorc_shards_watched gauge
vtorc_shards_watched{keyspace="REDACTED",shard="-0040"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="0040-0080"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="0080-00c0"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="00c0-0100"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="0100-0140"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="0140-0180"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="0180-01c0"} 1
vtorc_shards_watched{keyspace="REDACTED",shard="01c0-0200"} 1

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
Labels
Component: VTorc Vitess Orchestrator integration Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: add stats for keyspace/shards watched by VTOrc
1 participant