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.

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

vtgate: support filtering tablets by tablet-tags #15911

Merged
merged 17 commits into from
Jun 3, 2024
Merged

vtgate: support filtering tablets by tablet-tags #15911

merged 17 commits into from
Jun 3, 2024

Conversation

timvaillancourt
Copy link
Contributor

@timvaillancourt timvaillancourt commented May 9, 2024 •
edited
Loading

Description

This PR implements the RFC: #15908 by:

  1. Adding the vtgate flag: --tablet-filter-tags StringMap for a list of tablet-tag KVs to match
  2. Considering this optional filter in the healthcheck code

This support works in addition (a secondary filter) to the mutually-exclusive --tablet_filter / --keyspaces_to_watch features

If/when there is agreement on the approach I will add documentation for the new support and flag

Related Issue(s)

Resolves #15908

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
vtgate: support filtering tablets by tablet-tags
b580794 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
cleanup
7f27e66 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented May 9, 2024 •
edited by timvaillancourt
Loading

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 9, 2024
@timvaillancourt timvaillancourt linked an issue May 9, 2024 that may be closed by this pull request
RFC: allow vtgate to filter tablets by tag K/Vs #15908
Closed
@github-actions github-actions bot added this to the v20.0.0 milestone May 9, 2024
@timvaillancourt timvaillancourt changed the title Vttablet tablet filter tags vtgate: support filtering tablets by tablet-tags May 9, 2024
@timvaillancourt timvaillancourt marked this pull request as ready for review May 9, 2024 23:36
@timvaillancourt
Fix comment
bc1f7b1 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
missing flags e2e updates
9a6eca5 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt timvaillancourt added Component: Query Serving and removed 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 May 10, 2024
@codecov Codecov
Copy link

codecov bot commented May 10, 2024 •
edited
Loading

Codecov Report

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

Project coverage is 68.22%. Comparing base (f118ba2) to head (7e38cf1).
Report is 136 commits behind head on main.

Files Patch % Lines
go/vt/discovery/healthcheck.go 42.85% 4 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15911      +/-   ##
==========================================
- Coverage   68.40%   68.22%   -0.19%     
==========================================
  Files        1556     1541      -15     
  Lines      195121   197254    +2133     
==========================================
+ Hits       133479   134570    +1091     
- Misses      61642    62684    +1042

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

@timvaillancourt timvaillancourt added the Type: Enhancement Logical improvement (somewhere between a bug and feature) label May 10, 2024
@timvaillancourt
add TabletFilters abstraction
c8953e8 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
just use 'var'
e55428c 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
[]TabletFilter -> TabletFilters
56de44b 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
use TabletFilter interface
9f9cd1d 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
skip tablet-tag match if PRIMARY
64b80ab 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Add test for PRIMARY
2a3e5b3 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
move PRIMARY check to TabletFilters
325b04a 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
remove PRIMARY filter bypass
7954a3a 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
use append always
d3989cd 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
additional test
f1751ef 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
deepthi
deepthi approved these changes May 31, 2024
View reviewed changes
Copy link
Member

@deepthi deepthi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

In general I tend to be thrifty about adding new flags, but this seems like a logical extension of the tags feature of the tablet (which already exists for whatever reason), so I'm not objecting to this.
The implementation and unit tests look fine. I'll leave it to you to investigate and fix the unit tests.

@deepthi deepthi requested a review from a team May 31, 2024 19:55
frouioui
frouioui approved these changes May 31, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Left a comment on something i am not sure about. Otherwise, besides the failing tests LGTM.

We should probably do a single website PR that gathers the new flags introduced by this PR and #15919.

go/vt/discovery/healthcheck.go
}
topoWatchers = append(topoWatchers, NewTopologyWatcher(ctx, topoServer, hc, filter, c, refreshInterval, refreshKnownTablets, topo.DefaultConcurrency))
topoWatchers = append(topoWatchers, NewTopologyWatcher(ctx, topoServer, hc, filters, c, refreshInterval, refreshKnownTablets, topo.DefaultConcurrency))
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't we reset the filters slice here? Otherwise we keep appending the same filters over and over again for each cells.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@frouioui good catch! yes, this should be a reset each iteration of the loop, updated 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@frouioui re-requested review on the fix 🙇

@timvaillancourt
reset filters per loop of cells
55aa9e4 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt
Fix partial match test
2f7a0a1 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
shlomi-noach
shlomi-noach approved these changes Jun 2, 2024
View reviewed changes
go/vt/discovery/topology_watcher.go Outdated Show resolved Hide resolved
@shlomi-noach
Copy link
Contributor

Reminder for a website PR.

@timvaillancourt @shlomi-noach
Update go/vt/discovery/topology_watcher.go
7e38cf1 
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@shlomi-noach
Copy link
Contributor

Will merge this PR without website changes, so as to get this into v20 before code freeze. Ideally the website PR will follow before RC1 next week.

@shlomi-noach shlomi-noach removed the NeedsWebsiteDocsUpdate What it says label Jun 3, 2024
@shlomi-noach shlomi-noach merged commit f4591fb into vitessio:main Jun 3, 2024
93 of 94 checks passed
@timvaillancourt timvaillancourt deleted the vttablet-tablet-filter-tags branch June 3, 2024 21:19
timvaillancourt added a commit to timvaillancourt/vitess that referenced this pull request Jun 4, 2024
@timvaillancourt
Add changelogs for PR vitessio#15911 and vitessio#15919
dcffa96 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@timvaillancourt timvaillancourt mentioned this pull request Jun 4, 2024
Merged
5 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Jun 4, 2024
@timvaillancourt @shlomi-noach
vtgate: support filtering tablets by tablet-tags (vitessio#15911)
d0e0931 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@timvaillancourt timvaillancourt mentioned this pull request Jun 4, 2024
Merged
4 tasks
shlomi-noach pushed a commit that referenced this pull request Jun 4, 2024
@timvaillancourt
Add changelogs for PR #15911 and #15919 (#16044)
d00ea7e 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Jun 4, 2024
@timvaillancourt @shlomi-noach
@harshit-gangal @deepthi
slack-15.0: v20 backports, pt. 2 (#394)
b0c5325 
* `vtgate`: support filtering tablets by tablet-tags  (vitessio#15911)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Add support for sampling rate in `streamlog` (vitessio#15919)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix merge conflict resolution

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update rand import

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Add sql text counts stats to `vtcombo`,`vtgate`+`vttablet` (vitessio#15897)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>

* missing rename

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* missing rename again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Jul 18, 2024
@timvaillancourt @shlomi-noach
vtgate: support filtering tablets by tablet-tags (vitessio#15911)
48ba53a 
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@timvaillancourt timvaillancourt mentioned this pull request Jul 18, 2024
Merged
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Jul 18, 2024
@timvaillancourt @shlomi-noach
@harshit-gangal @deepthi
slack-19.0: v20 backports, pt. 2 (#459)
a0a9e11 
* `vtgate`: support filtering tablets by tablet-tags  (vitessio#15911)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Add support for sampling rate in `streamlog` (vitessio#15919)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Add sql text counts stats to `vtcombo`,`vtgate`+`vttablet` (vitessio#15897)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>

---------

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: Harshit Gangal <harshit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shlomi-noach shlomi-noach shlomi-noach approved these changes

@deepthi deepthi deepthi approved these changes

@frouioui frouioui Awaiting requested review from frouioui frouioui is a code owner

Assignees
No one assigned
Labels
Component: Query Serving Component: VTGate Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.

RFC: allow vtgate to filter tablets by tag K/Vs
4 participants
@timvaillancourt @shlomi-noach @deepthi @frouioui