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

tx throttler: remove unused topology watchers #14412

Merged
merged 4 commits into from
Nov 1, 2023
Merged

tx throttler: remove unused topology watchers #14412

merged 4 commits into from
Nov 1, 2023

Conversation

deepthi
Copy link
Member

@deepthi deepthi commented Oct 31, 2023 •
edited
Loading

Description

We had topology watchers in TxThrottler even though they are no longer needed or used. Healthcheck already encapsulates a topology watcher per cell. Cleaning this up in preparation for the actual work needed to fix #14277.
I have also rewritten most of the comments in healthcheck.go because a lot of them were obsolete or incorrect.

Related Issue(s)

#14277

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@deepthi
healthcheck: edit comments for correctness
9b04f1d 
Signed-off-by: deepthi <deepthi@planetscale.com>
@deepthi
tx_throttler: remove unused topology watchers
fecbcf5 
Signed-off-by: deepthi <deepthi@planetscale.com>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 31, 2023

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 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 Oct 31, 2023
@deepthi deepthi 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 labels Oct 31, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Oct 31, 2023
dbussink
dbussink reviewed Oct 31, 2023
View reviewed changes
go/vt/vttablet/tabletserver/txthrottler/tx_throttler.go Outdated
@@ -204,8 +199,7 @@ func NewTxThrottler(env tabletenv.Env, topoServer *topo.Server) TxThrottler {
config: config,
topoServer: topoServer,
throttlerRunning: env.Exporter().NewGauge(TxThrottlerName+"Running", "transaction throttler running state"),
topoWatchers: env.Exporter().NewGaugesWithSingleLabel(TxThrottlerName+"TopoWatchers", "transaction throttler topology watchers", "cell"),
healthChecksReadTotal: env.Exporter().NewCountersWithMultiLabels(TxThrottlerName+"HealthchecksRead", "transaction throttler healthchecks read",
topoWatchers: env.Exporter().NewGaugesWithSingleLabel(TxThrottlerName+"TopoWatchers", "DEPRECATED: transaction throttler topology watchers", "cell"), healthChecksReadTotal: env.Exporter().NewCountersWithMultiLabels(TxThrottlerName+"HealthchecksRead", "transaction throttler healthchecks read",
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like a newline here was removed which makes the diff a bit confusing?

Also, what is the general value / policy around metrics deprecations? Is it useful / expected for folks to have empty metrics? Does that have value over removing the metric?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll add back the newline. I went back and forth between deleting the metric versus deprecating. We need to deprecate so that people's existing metrics pipelines don't break without warning.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've added a line in the release notes for these.

Copy link
Contributor

Choose a reason for hiding this comment

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

We need to deprecate so that people's existing metrics pipelines don't break without warning.

But doesn't a metric that flatlines break things anyway? I think it's also possible to argue that having a metric go to zero is more confusing / problematic than removing it as a signal to the user that the value is (no longer) useful? I think this is tricky anyway, we can argue both ways but I don't think this is as clear cut as say a command line flag that is deprecated?

Copy link
Member Author

Choose a reason for hiding this comment

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

Honestly I don't know if anyone is even using this metric. It's not much effort to keep it deprecated and delete it in the next release, so I ended up choosing that as the "safer" approach.

@deepthi
tx_throttler: formatting
3fa9841 
Signed-off-by: deepthi <deepthi@planetscale.com>
@deepthi
release notes: document deprecated metrics
3f40609 
Signed-off-by: deepthi <deepthi@planetscale.com>
GuptaManan100
GuptaManan100 approved these changes Nov 1, 2023
View reviewed changes
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

LGTM

@GuptaManan100 GuptaManan100 merged commit 3924566 into vitessio:main Nov 1, 2023
115 checks passed
@GuptaManan100 GuptaManan100 deleted the ds-cleanup-tw branch November 1, 2023 14:00
This was referenced Nov 1, 2023
Closed
Closed
This was referenced Nov 2, 2023
Merged
Merged
timvaillancourt pushed a commit to slackhq/vitess that referenced this pull request May 16, 2024
@deepthi @timvaillancourt
tx throttler: remove unused topology watchers (vitessio#14412)
65333f6 
Signed-off-by: deepthi <deepthi@planetscale.com>
@timvaillancourt timvaillancourt mentioned this pull request May 16, 2024
Merged
4 tasks
timvaillancourt added a commit to slackhq/vitess that referenced this pull request May 21, 2024
@timvaillancourt @Juneezee
@shlomi-noach @ejortegau @deepthi
slack-vitess-r15.0.5: backport required Transaction Throttler PRs, …
4a92ae7 
…pt. 3 + ci fixes (#351)

* txthrottler: add metrics for topoWatcher and healthCheckStreamer (vitessio#13153)

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

* Replace deprecated `github.com/golang/mock` with `go.uber.org/mock` (vitessio#13512)

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Per workload TxThrottler metrics (vitessio#13526)

Signed-off-by: Eduardo J. Ortega U <5791035+ejortegau@users.noreply.github.com>

* tx throttler: healthcheck all cells if `--tx-throttler-healthcheck-cells` is undefined (vitessio#12477)

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

* Add dry-run/monitoring-only mode for TxThrottler (vitessio#13604)

Signed-off-by: Eduardo J. Ortega U <5791035+ejortegau@users.noreply.github.com>
Signed-off-by: Eduardo J. Ortega U. <5791035+ejortegau@users.noreply.github.com>

* `txthrottler`: remove `txThrottlerConfig` struct, rely on `tabletenv` (vitessio#13624)

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

* tx throttler: remove unused topology watchers (vitessio#14412)

Signed-off-by: deepthi <deepthi@planetscale.com>

* tx_throttler: delete topo watcher metric instead of deprecating (vitessio#14445)

Signed-off-by: deepthi <deepthi@planetscale.com>

* TxThrottler: dont throttle unless lag (vitessio#14789)

Signed-off-by: Eduardo J. Ortega U <5791035+ejortegau@users.noreply.github.com>

* go test -v

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

* add mutex to flaky parseFlags()

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

* revert tweaks for flaky tests

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

* fix protojson err

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

* make vtadmin_web_proto_types

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

* remove debug t.Logf(...)

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

---------

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Eduardo J. Ortega U <5791035+ejortegau@users.noreply.github.com>
Signed-off-by: Eduardo J. Ortega U. <5791035+ejortegau@users.noreply.github.com>
Signed-off-by: deepthi <deepthi@planetscale.com>
Co-authored-by: Eng Zer Jun <engzerjun@gmail.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: Eduardo J. Ortega U <5791035+ejortegau@users.noreply.github.com>
Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@dbussink dbussink dbussink approved these changes

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

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

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

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

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

Assignees
No one assigned
Labels
Component: Query Serving Type: Internal Cleanup
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: Reduce number of topo calls from vtgate healthcheck
3 participants
@deepthi @dbussink @GuptaManan100