Add stats for shards watched by VTOrc, purge stale shards

[timvaillancourt]

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

Finally, shards that do not meet the --clusters_to_watch key-ranges will not be saved to the backend. Currently all shards of a keyspace are stored

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

[vitess-bot]

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]

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

[codecov]

Codecov Report

Attention: Patch coverage is 36.84211% with 48 lines in your changes missing coverage. Please review.

Project coverage is 67.44%. Comparing base (70114ad) to head (092ab7a).
Report is 31 commits behind head on main.

Files with missing lines	Patch %	Lines
go/vt/vtorc/logic/keyspace_shard_discovery.go	0.00%	48 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #17815      +/-   ##
==========================================
- Coverage   67.94%   67.44%   -0.50%     
==========================================
  Files        1586     1594       +8     
  Lines      255224   259058    +3834     
==========================================
+ Hits       173420   174731    +1311     
- Misses      81804    84327    +2523     

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

[timvaillancourt]

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

[timvaillancourt]

After testing internally this PR isn't quite ready

It seems vitess_shard contains every shard in every keyspace, not filtered by --clusters_to_watch, so this doesn't give a clear representation of what's being watched

[timvaillancourt]

It seems vitess_shard contains every shard in every keyspace, not filtered by --clusters_to_watch, so this doesn't give a clear representation of what's being watched

@GuptaManan100 fixed this issue above. Will test on real hosts tomorrow.

Re-requested review 🙇

[GuptaManan100]

LGTM